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.

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

Auto-generated docs prevent missing_docs lint #132

Open
ggwpez opened this issue Aug 16, 2023 · 1 comment
Open

Auto-generated docs prevent missing_docs lint #132

ggwpez opened this issue Aug 16, 2023 · 1 comment
Labels
T1-FRAME This PR/Issue is related to core FRAME, the framework.

Comments

@ggwpez
Copy link
Member

ggwpez commented Aug 16, 2023

Pallet storage items got some auto-generated docs introduced here.
This makes deny(missing_docs) useless, since there are always the auto-generated docs. For example a map has this:
Storage type is [StorageMap] with key type u8 and value type u16.

I think we should either:

  • remove the auto-generated docs
  • only generate them when there already are docs
  • emit a warning from the pallet macro if there are no docs but still auto-generate some
  • create a phony public type that has the same docs and span as the original storage item, so that the lint still works. This way we can keep the auto-generation but also have the lint still work.
@juangirini juangirini transferred this issue from paritytech/substrate Aug 24, 2023
@the-right-joyce the-right-joyce added T1-FRAME This PR/Issue is related to core FRAME, the framework. and removed S0-design labels Aug 25, 2023
@ggwpez
Copy link
Member Author

ggwpez commented Sep 13, 2023

cc @wentelteefje

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T1-FRAME This PR/Issue is related to core FRAME, the framework.
Projects
Status: Backlog
Development

No branches or pull requests

3 participants