This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
pallet macros: Improve emitted rustdoc #8276
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
athei
added
A0-please_review
athei
added
C1-low
athei
changed the title
gui1117
approved these changes
Mar 5, 2021
shawntabrizi
approved these changes
Mar 6, 2021
|
bot merge |
|
Checks failed; merge aborted. |
It's cargo deny again. Can someone with privileges merge this? |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Having types in the reference documentation without a rust doc creates a low quality impression. That said, many types emitted or augmented by the pallet macro don't need custom docs because those are well known types like
CallandConfigwhich pretty much can get a stock documentation pointing users to the relevant knowledge base article.This PR emits such a stock documentation for the well known types in case no own documentation is specified.
mod pallet,Config,GenesisConfig,Pallet,Call,Error,EventCallvariants (copied from the pallet impl)Please also review and improve the actual docs emitted.