Skip to content
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

Jump to bottom

doc: document public api #161

Merged
merged 22 commits into from
Jan 10, 2024
Merged

doc: document public api #161

merged 22 commits into from
Jan 10, 2024

Conversation

zvolin
Copy link
Member

@zvolin zvolin commented Dec 7, 2023

No description provided.

@zvolin zvolin force-pushed the doc/document-pub-api branch 3 times, most recently from 0488e08 to 0b8e967 Compare December 8, 2023 12:18
fl0rek
fl0rek reviewed Dec 11, 2023
View reviewed changes
Copy link
Member

@fl0rek fl0rek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nicely done, few nitpics :)

types/src/blob.rs Outdated Show resolved Hide resolved
types/src/blob.rs Outdated Show resolved Hide resolved
types/src/blob.rs Show resolved Hide resolved
types/src/block.rs Outdated Show resolved Hide resolved
types/src/consts.rs Outdated Show resolved Hide resolved
types/src/extended_header.rs Outdated Show resolved Hide resolved
types/src/fraud_proof.rs Outdated Show resolved Hide resolved
types/src/hash.rs Outdated Show resolved Hide resolved
types/src/nmt.rs Outdated Show resolved Hide resolved
types/src/nmt.rs Outdated Show resolved Hide resolved
@zvolin zvolin force-pushed the doc/document-pub-api branch 5 times, most recently from c36551f to cc4d55d Compare December 14, 2023 15:23
@zvolin zvolin force-pushed the doc/document-pub-api branch 3 times, most recently from 48143d5 to 4bf1a0e Compare December 29, 2023 09:35
@zvolin zvolin marked this pull request as ready for review January 3, 2024 08:35
@zvolin zvolin changed the title Doc/document pub api doc: document public api Jan 3, 2024
@zvolin zvolin linked an issue Jan 3, 2024 that may be closed by this pull request
Add documentation and polish things before releasing to crates.io #158
Closed
@zvolin zvolin requested review from fl0rek and oblique January 3, 2024 14:00
@zvolin zvolin mentioned this pull request Jan 5, 2024
Merged
fl0rek
fl0rek reviewed Jan 8, 2024
View reviewed changes
node-wasm/README.md Outdated Show resolved Hide resolved
node/src/p2p.rs Show resolved Hide resolved
node/src/p2p.rs Outdated Show resolved Hide resolved
node/src/peer_tracker.rs Outdated Show resolved Hide resolved
types/src/extended_header.rs Outdated Show resolved Hide resolved
types/src/share.rs Outdated Show resolved Hide resolved
types/src/state/address.rs Outdated Show resolved Hide resolved
types/src/state/address.rs Outdated Show resolved Hide resolved
types/src/state/address.rs Outdated Show resolved Hide resolved
types/src/state/address.rs Outdated Show resolved Hide resolved
fl0rek and others added 4 commits January 8, 2024 14:05
@fl0rek
Apply trivial suggestions
89b11f6 
Applying suggestions with articles, capitalisation or typos. Again -  feel free to roll back.

Signed-off-by: Mikołaj Florkiewicz <mikolaj@florkiewicz.me>
@zvolin @fl0rek
Apply suggestions from code review
4bb1c83 
Co-authored-by: Mikołaj Florkiewicz <mikolaj@florkiewicz.me>
Signed-off-by: Maciej Zwoliński <mac.zwolinski@gmail.com>
@zvolin @fl0rek
Apply suggestions from code review
3973104 
Co-authored-by: Mikołaj Florkiewicz <mikolaj@florkiewicz.me>
Signed-off-by: Maciej Zwoliński <mac.zwolinski@gmail.com>
@zvolin
add link to the absence proof
49e8b9b
fl0rek
fl0rek approved these changes Jan 10, 2024
View reviewed changes
Copy link
Member

@fl0rek fl0rek left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, our docs look much more professional now 🎸
Minor suggestions, mostly definite/indefinite articles :D

node-wasm/src/utils.rs Outdated Show resolved Hide resolved
node/src/network.rs Show resolved Hide resolved
node/src/network.rs Outdated Show resolved Hide resolved
node/src/network.rs Outdated Show resolved Hide resolved
node/src/p2p.rs Outdated Show resolved Hide resolved
types/src/nmt/namespaced_hash.rs Outdated Show resolved Hide resolved
types/src/nmt/namespaced_hash.rs Outdated Show resolved Hide resolved
types/src/rsmt2d.rs Outdated Show resolved Hide resolved
types/src/sync.rs Outdated Show resolved Hide resolved
types/src/sync.rs Outdated Show resolved Hide resolved
@zvolin @fl0rek
Apply suggestions from code review
4695da8 
Co-authored-by: Mikołaj Florkiewicz <mikolaj@florkiewicz.me>
Signed-off-by: Maciej Zwoliński <mac.zwolinski@gmail.com>
oblique
oblique approved these changes Jan 10, 2024
View reviewed changes
Copy link
Member

@oblique oblique left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work!! I have some minor comments.

README.md Outdated Show resolved Hide resolved
blockstore/src/lib.rs Outdated Show resolved Hide resolved
blockstore/src/lib.rs Outdated Show resolved Hide resolved
types/src/nmt.rs Outdated Show resolved Hide resolved
types/src/nmt/namespace_proof.rs Outdated Show resolved Hide resolved
types/src/state/tx.rs Outdated Show resolved Hide resolved
zvolin and others added 3 commits January 10, 2024 14:31
@zvolin @oblique
Apply suggestions from code review
4621e9d 
Co-authored-by: Yiannis Marangos <psyberbits@gmail.com>
Signed-off-by: Maciej Zwoliński <mac.zwolinski@gmail.com>
@zvolin
use const qualifiers in Namespace::const_vX examples
0d26930
@zvolin
Introduce EMPTY_LEAVES constant for absence proofs
e24d604
oblique
oblique approved these changes Jan 10, 2024
View reviewed changes
Copy link
Member

@oblique oblique left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@fl0rek fl0rek merged commit a07d875 into eigerco:main Jan 10, 2024
6 checks passed
@zvolin zvolin deleted the doc/document-pub-api branch January 10, 2024 13:54
This was referenced Jan 12, 2024
Merged
Closed
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fl0rek fl0rek fl0rek approved these changes

@oblique oblique oblique approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add documentation and polish things before releasing to crates.io
3 participants
@zvolin @oblique @fl0rek