Skip to content
Snippets Groups Projects
  • STEVAN Antoine's avatar
    8c61c2ce
    finish the documentation (!198) · 8c61c2ce
    STEVAN Antoine authored
    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
    
    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
      - [x] (:newspaper2:) (:gear:) `algebra`: check the length for `algebra::powers_of`
      - [x] (:newspaper2:) (:gear:) `algebra::linalg`: use exact matches in the error tests and use struct errors
      - [x] (:newspaper2:) (:gear:) `error`: change some errors to struct errors
      - [x] (:newspaper2:) (:gear:) `fs`: rename some arguments, e.g. `block_hashes` to `hashes` and `dump_dir` to `directory`
      - [x] (:newspaper2:) (:gear:) `zk`: inline `check_degree_is_too_large`
      - [x] (:newspaper2:)          `fec`
      - [x] (:newspaper2:)          `semi_avid`
      - [x] (:newspaper2:)          `kzg`
      - [x] (:newspaper2:) (:gear:) `aplonk`: remove `Commitment` and `VerifierKey`
      - [ ] (:newspaper2:)          `fri`
      - [x] (:newspaper2:)          Komodo (`lib.rs`)
    8c61c2ce
    History
    finish the documentation (!198)
    STEVAN Antoine authored
    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
    
    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
      - [x] (:newspaper2:) (:gear:) `algebra`: check the length for `algebra::powers_of`
      - [x] (:newspaper2:) (:gear:) `algebra::linalg`: use exact matches in the error tests and use struct errors
      - [x] (:newspaper2:) (:gear:) `error`: change some errors to struct errors
      - [x] (:newspaper2:) (:gear:) `fs`: rename some arguments, e.g. `block_hashes` to `hashes` and `dump_dir` to `directory`
      - [x] (:newspaper2:) (:gear:) `zk`: inline `check_degree_is_too_large`
      - [x] (:newspaper2:)          `fec`
      - [x] (:newspaper2:)          `semi_avid`
      - [x] (:newspaper2:)          `kzg`
      - [x] (:newspaper2:) (:gear:) `aplonk`: remove `Commitment` and `VerifierKey`
      - [ ] (:newspaper2:)          `fri`
      - [x] (:newspaper2:)          Komodo (`lib.rs`)
Code owners
Assign users and groups as approvers for specific file changes. Learn more.