Skip to content
Snippets Groups Projects

finish the documentation

Merged STEVAN Antoine requested to merge doc into main

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

:bulb: 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

  • :newspaper2: is for documentation changes
  • :gear: is for code changes
  • (:newspaper2:) moves the RUSTDOCFLAGS for Katex activation to .cargo/config.toml
  • (:newspaper2:) adds simple_mermaid for Mermaid graphs
  • (:newspaper2:) upgrades Katex from 0.10.0 to 0.16.21 for matrix support
  • documentation
    • (:newspaper2:) (:gear:) algebra: check the length for algebra::powers_of
    • (:newspaper2:) (:gear:) algebra::linalg: use exact matches in the error tests and use struct errors
    • (:newspaper2:) (:gear:) error: change some errors to struct errors
    • (:newspaper2:) (:gear:) fs: rename some arguments, e.g. block_hashes to hashes and dump_dir to directory
    • (:newspaper2:) (:gear:) zk: inline check_degree_is_too_large
    • (:newspaper2:) fec
    • (:newspaper2:) semi_avid
    • (:newspaper2:) kzg
    • (:newspaper2:) (:gear:) aplonk: remove Commitment and VerifierKey
    • (:newspaper2:) fri
    • (:newspaper2:) Komodo (lib.rs)
Edited by STEVAN Antoine

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
Please register or sign in to reply
Loading