Skip to content

Fix typos and formatting in documentation #288

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.

Sign up for GitHub

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

Open
vtjl10 wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Fix typos and formatting in documentation #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
79f5ab2
Update readme.md
vtjl10 Jan 20, 2025
e4e64b7
Update implementation.md
vtjl10 Jan 20, 2025
caa1247
Update implementation.md
vtjl10 Jan 20, 2025
4d818e2
Update quickstart.md
vtjl10 Jan 20, 2025
938bdb7
Merge branch 'master' into master
vtjl10 Jan 22, 2025
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
2 changes: 1 addition & 1 deletion crypto3/docs/manual/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Quickstart
========================

By the end of this guide, you will have set up a development environment for crypto3 projects
and be able to run an example.This will enable you to test ideas quickly and further explore the
and be able to run an example. This will enable you to test ideas quickly and further explore the
API's of the suite.

## Install dependencies
Expand Down
6 changes: 3 additions & 3 deletions crypto3/libs/algebra/docs/implementation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Algebra library consists of several modules listed below:
2. Elliptic curves arithmetic
3. Pairings on elliptic curves
4. Multiexponentiation algorithm (will be part of some other module after a while)
5. Matricies and vectors
5. Matrices and vectors

This separation defines the implementation architecture.

Expand Down Expand Up @@ -57,7 +57,7 @@ A field policy describes its essential parameters such as `modulus`, `arity` or

### Field Extensions ### {#field_extensions}

For the purposes of effictive field/elliptic curve operations and pairings evaluation fields are arranged as a field tower.
For the purposes of effective field/elliptic curve operations and pairings evaluation fields are arranged as a field tower.

For example, this is the tower used for `bn128` and `bls12_381` operations and pairings evaluation:

Expand Down Expand Up @@ -167,7 +167,7 @@ are based on the underlying field algorithms are also defined here.

### Basic Curve Policies ### {#basic_curve_policies}

Main reason for existence of basic policyis is that we need some of it params using in group element and pairing arithmetic.
Main reason for existence of basic policy is is that we need some of it params using in group element and pairing arithmetic.
So it contains such parameters that are needed by group element arithmetic e.g. coeffs `a` and `b` or generator coordinates `x`, `y`.
It also contains all needed information about the underlying fields.

Expand Down
4 changes: 2 additions & 2 deletions crypto3/libs/hash/docs/implementation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ processed. While `OutputIterator` provides a type-independent output place for t
which particular range this `OutputIterator`
represents.

Since C++20 this algorithm got it analogous inside Ranges library as follows:
Since C++20 this algorithm got it analogues inside Ranges library as follows:

```cpp
template<typename InputRange, typename OutputRange, typename UnaryOperation>
Expand Down Expand Up @@ -283,4 +283,4 @@ Such a state holder is split to a couple of types:
1. Value holder. Intended to have an internal output data storage. Actually stores the `AccumulatorSet` with digest
data.
2. Reference holder. Intended to store a reference to external `AccumulatorSet`, which is usable in case of data gets
appended to existing accumulator.
appended to existing accumulator.
4 changes: 2 additions & 2 deletions crypto3/libs/marshalling/zk/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ To actually include this library in a project it is required to:
* [Algebra](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/algebra)
* [ZK](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/zk)
* [=nil;Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshalling)
* [=nil;Crypto3 Multiprecision Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshaling/multiprecision)
* [=nil;Crypto3 ALgebra Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshaling/algebra)
* [=nil;Crypto3 Multiprecision Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshalling/multiprecision)
* [=nil;Crypto3 ALgebra Marshalling](https://github.com/NilFoundation/placeholder/tree/master/crypto3/libs/marshalling/algebra)

### External

Expand Down