A0-3132: Add pallets documentation to metadata #1403
Merged
Conversation
This file contains 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
kostekIV
reviewed
Sep 18, 2023
kostekIV
approved these changes
Sep 19, 2023
mike1729
approved these changes
Sep 19, 2023
fixxxedpoint
pushed a commit
that referenced
this pull request
Sep 25, 2023
# Description paritytech/substrate#13452 adds the possibility to include readme.md (markdown) docs into pallet metadata. This is not yet supported in our current metadata, yet it is a preparation in case metadata V15 lands on our chain. Also, this PR slightly reduces docs duplication by extracting our pallet file docs to README.md. That should be beneficial to a reader who browse pallet code in GH. ## Type of change Please delete options that are not relevant. - New feature (non-breaking change which adds functionality) ## Testing - run `cargo doc` for our pallets
# for free
to join this conversation on GitHub.
Already have an account?
# 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
paritytech/substrate#13452 adds the possibility to include readme.md (markdown) docs into pallet metadata. This is not yet supported in our current metadata, yet it is a preparation in case metadata V15 lands on our chain.
Also, this PR slightly reduces docs duplication by extracting our pallet file docs to README.md. That should be beneficial to a reader who browse pallet code in GH.
Type of change
Please delete options that are not relevant.
Testing
cargo docfor our pallets