docs: migrate // comments to /// rustdoc across all 6 contract crates - #50
Open
chazepay wants to merge 1 commit into
Open
docs: migrate // comments to /// rustdoc across all 6 contract crates#50chazepay wants to merge 1 commit into
chazepay wants to merge 1 commit into
Conversation
… - Replace floating // block comments at module level with //! crate-level docs - Add structured /// rustdoc (# Arguments, # Returns, # Panics, # Examples) to every public fn, struct, enum variant, event struct, and const in all 6 crates: badge-nft, course-registry, reward-pool, stake-vault, quest-engine, governance - Add 5+ doctests in /// blocks across badge-nft, course-registry, stake-vault, reward-pool, and governance - Remove inline // step-comment scaffolding from all function bodies - Add storage-layout tables to all DataKey and struct type docs - Add cargo doc --no-deps --document-private-items zero-warning check to CI - Add docs publish job to GitHub Pages on version tags (v*) Closes Kqirox#23
Contributor
|
@chazepay resolve conflicts |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
every public fn, struct, enum variant, event struct, and const in all 6 crates:
badge-nft, course-registry, reward-pool, stake-vault, quest-engine, governance
reward-pool, and governance
Closes #23