-
- Downloads
finish the documentation (!198)
this is an attempt at finishing the documentation for real. the convention is - start sentences with capital letter, speaks as 3rd person and end with period - specify non-trivial cases and returns in the doc, otherwise, leave that to the tests - use mathematical formulae to make things more clear >**Note** > > might supersede !184 For now, i completely skipped FRI because i thought we could do that in a later MR, as it was added later and is not even part of a public release yet. I also went a bit faster on _aPlonK_ as it is so complex and we will likely never use it. ## changelog > - is for documentation changes > - is for code changes - ( ) moves the `RUSTDOCFLAGS` for Katex activation to `.cargo/config.toml` - ( ) adds `simple_mermaid` for Mermaid graphs - ( ) upgrades Katex from `0.10.0` to `0.16.21` for matrix support - documentation - [x] ( ) ( ) `algebra`: check the length for `algebra::powers_of` - [x] ( ) ( ) `algebra::linalg`: use exact matches in the error tests and use struct errors - [x] ( ) ( ) `error`: change some errors to struct errors - [x] ( ) ( ) `fs`: rename some arguments, e.g. `block_hashes` to `hashes` and `dump_dir` to `directory` - [x] ( ) ( ) `zk`: inline `check_degree_is_too_large` - [x] ( ) `fec` - [x] ( ) `semi_avid` - [x] ( ) `kzg` - [x] ( ) ( ) `aplonk`: remove `Commitment` and `VerifierKey` - [ ] ( ) `fri` - [x] ( ) Komodo (`lib.rs`)
Showing
- .cargo/config.toml 2 additions, 0 deletions.cargo/config.toml
- Cargo.toml 1 addition, 0 deletionsCargo.toml
- katex.html 4 additions, 3 deletionskatex.html
- make.rs 1 addition, 1 deletionmake.rs
- src/algebra/linalg.rs 110 additions, 101 deletionssrc/algebra/linalg.rs
- src/algebra/mod.rs 88 additions, 37 deletionssrc/algebra/mod.rs
- src/aplonk/ipa.rs 7 additions, 7 deletionssrc/aplonk/ipa.rs
- src/aplonk/mod.mmd 15 additions, 0 deletionssrc/aplonk/mod.mmd
- src/aplonk/mod.rs 47 additions, 24 deletionssrc/aplonk/mod.rs
- src/aplonk/polynomial.rs 31 additions, 31 deletionssrc/aplonk/polynomial.rs
- src/aplonk/transcript.rs 3 additions, 3 deletionssrc/aplonk/transcript.rs
- src/error.rs 34 additions, 22 deletionssrc/error.rs
- src/fec.mmd 15 additions, 0 deletionssrc/fec.mmd
- src/fec.rs 70 additions, 33 deletionssrc/fec.rs
- src/fs.rs 22 additions, 22 deletionssrc/fs.rs
- src/kzg.mmd 18 additions, 0 deletionssrc/kzg.mmd
- src/kzg.rs 36 additions, 23 deletionssrc/kzg.rs
- src/lib.mmd 12 additions, 0 deletionssrc/lib.mmd
- src/lib.rs 11 additions, 3 deletionssrc/lib.rs
- src/semi_avid.mmd 15 additions, 0 deletionssrc/semi_avid.mmd
Loading
Please register or sign in to comment