Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs fix spelling issues #699

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CHANGELOG_OLD.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
We take inspiration from [keep changelog](https://keepachangelog.com/en/1.0.0/) and [arkworks](https://github.com/arkworks-rs/algebra/blob/master/CHANGELOG.md).

**Breaking Changes** and **Fixed** contain backward incompatible changes, bug fixes, and security patches;
**Added, Changed, Removed, Deprecated** contain backward compatible improvements or new features.
**Added, Changed, Removed, Deprecated** contains backward compatible improvements or new features.

## [Unreleased](https://github.com/EspressoSystems/jellyfish/compare/0.4.0...main)

Expand Down Expand Up @@ -38,8 +38,8 @@ We take inspiration from [keep changelog](https://keepachangelog.com/en/1.0.0/)
- Remove the unnecessary trait bounds, for example `I: From<u64>`.
- Restricting the index type for `AppendableMerkleTreeScheme` to be `u64`.
- Add new `update_with()` and `remove()` interface for the universal Merkle tree.
- Add new `iter()` interface for Merkle tree scheme, allows user to iterate through all elements that are in memory.
- [#489](https://github.com/EspressoSystems/jellyfish/pull/489) (`jf-primitives`) Add non destructive universal Merkle tree.
- Add new `iter()` interface for Merkle tree scheme, allowing the user to iterate through all elements that are in memory.
- [#489](https://github.com/EspressoSystems/jellyfish/pull/489) (`jf-primitives`) Add non-destructive universal Merkle tree.

### Fixed

Expand All @@ -53,7 +53,7 @@ We take inspiration from [keep changelog](https://keepachangelog.com/en/1.0.0/)
- [#231](https://github.com/EspressoSystems/jellyfish/pull/231) Implemented FK23 for fast amortized opening for univariate PCS
- [#225](https://github.com/EspressoSystems/jellyfish/pull/225) Implemented Reed Solomon erasure code
- [#254](https://github.com/EspressoSystems/jellyfish/pull/254) Ensure `no_std` and target WASM support
- [#271](https://github.com/EspressoSystems/jellyfish/pull/271) Serde support for Aggregateable signatures
- [#271](https://github.com/EspressoSystems/jellyfish/pull/271) Serde support for Aggregatable signatures
- [#291](https://github.com/EspressoSystems/jellyfish/pull/291) Non-native field operations and elliptic curve addition
- [#309](https://github.com/EspressoSystems/jellyfish/pull/309) Reed-Solomon decoder accept FFT domain
- [#320](https://github.com/EspressoSystems/jellyfish/pull/320) Non-native elliptic curve addition in short Weierstrass form
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For general discussions on Jellyfish PLONK, please join our [Discord channel](ht
- ['jf-utils'](utilities): utilities and helper functions.

### Primitives
- ['jf-prf'](prf): trait definitions for pesudorandom function (PRF).
- ['jf-prf'](prf): trait definitions for pseudorandom function (PRF).
- ['jf-crhf'](crhf): trait definitions for collision-resistant hash function (CRHF).
- ['jf-commitment'](commitment): trait definitions for cryptographic commitment scheme.
- ['jf-rescue'](rescue): Rescue hash function, and its subsequent PRF, CRHF, commitment scheme implementations.
Expand Down Expand Up @@ -132,7 +132,7 @@ cargo fmt
Run `nix flake update` if you would like to pin other version edit `flake.nix`
beforehand. Commit the lock file when happy.

To update only a single input specify it as argument, for example
To update only a single input specify it as an argument, for example

nix flake update github:oxalica/rust-overlay

Expand Down
Loading