finish the documentation
-
Review changes -
-
Download -
Patches
-
Plain diff
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 (closed)
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 theRUSTDOCFLAGS
for Katex activation to.cargo/config.toml
- (
) addssimple_mermaid
for Mermaid graphs - (
) upgrades Katex from0.10.0
to0.16.21
for matrix support - documentation
-
( ) ( )algebra
: check the length foralgebra::powers_of
-
( ) ( )algebra::linalg
: use exact matches in the error tests and use struct errors -
( ) ( )error
: change some errors to struct errors -
( ) ( )fs
: rename some arguments, e.g.block_hashes
tohashes
anddump_dir
todirectory
-
( ) ( )zk
: inlinecheck_degree_is_too_large
-
( )fec
-
( )semi_avid
-
( )kzg
-
( ) ( )aplonk
: removeCommitment
andVerifierKey
-
( )fri
-
( ) Komodo (lib.rs
)
-
Edited by STEVAN Antoine
Merge request reports
Compare and
- version 1967090883
- version 18231f7d0c
- version 173af57bc5
- version 163fef202d
- version 158cf37868
- version 14cd60037a
- version 133a6c5144
- version 12ce8d0b80
- version 11d552d7cf
- version 1057ba9791
- version 950289920
- version 82aa2c7a9
- version 72305ea90
- version 683b5df67
- version 50df46a83
- version 4dcc40ee9
- version 3ba26e8c5
- version 2cd9caae0
- version 13095c620
- main (base)
- latest version2ca29bfd62 commits,
- version 196709088361 commits,
- version 18231f7d0c60 commits,
- version 173af57bc546 commits,
- version 163fef202d45 commits,
- version 158cf3786844 commits,
- version 14cd60037a43 commits,
- version 133a6c514441 commits,
- version 12ce8d0b8040 commits,
- version 11d552d7cf39 commits,
- version 1057ba979138 commits,
- version 95028992038 commits,
- version 82aa2c7a937 commits,
- version 72305ea9033 commits,
- version 683b5df6728 commits,
- version 50df46a8327 commits,
- version 4dcc40ee926 commits,
- version 3ba26e8c523 commits,
- version 2cd9caae022 commits,
- version 13095c62019 commits,
Compare changes
- Side-by-side
- Inline
Files
22Loading