chore(docs): unify rustdoc style across pallet-subtensor#2603
Draft
mcjkula wants to merge 7 commits intoopentensor:devnet-readyfrom
Draft
chore(docs): unify rustdoc style across pallet-subtensor#2603mcjkula wants to merge 7 commits intoopentensor:devnet-readyfrom
mcjkula wants to merge 7 commits intoopentensor:devnet-readyfrom
Conversation
Made-with: Cursor
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.
Description
Standardizes rustdoc comments across
pallets/subtensor/src/on one canonical convention.Split into 7 commits:
e7ec631: strip decorative/// ---//// ===/ banner lines82f7793: normalize section headings (# Args-># Arguments, etc.)77ce515: replaceReturns an error if:prose with named# Errorsbullets3917853: normalize event / error bullets to* 'Name': desc.b1d136d: convert/// NOTE:/WARNING:/TODO:admonitions to headings or//c35f571: move inline arg bullets under a proper# Argumentssectione3abf8f: normalize argument / return bullets to* `name`: desc.Verified locally:
cargo clippy -p pallet-subtensor --all-targets -- -D warningsandcargo fmt --check.Related Issue(s)
N/A
Type of Change
Breaking Change
None. This change is confined to
///rustdoc comments and a small number of//developer comments insidepallets/subtensor/src/.Checklist
./scripts/fix_rust.shto ensure my code is formatted and linted correctlyScreenshots (if applicable)
N/A - documentation-only change, no UI surface.
Additional Notes
Commit
77ce515is the only one that adds new information (error-name enumerations in 5 extrinsics). Every name was cross-checked against the realError::<T>::*call sites. All other commits are just reformatting.