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

deny missing docs on public items #304

Closed
3 tasks
sam0x17 opened this issue Apr 8, 2024 · 0 comments · Fixed by #400
Closed
3 tasks

deny missing docs on public items #304

sam0x17 opened this issue Apr 8, 2024 · 0 comments · Fixed by #400
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sam0x17
Copy link
Contributor

sam0x17 commented Apr 8, 2024

Right now we actually have a lot of // comments that are intended to be /// doc comments. This is rampant throughout our pallets. A really good way to fix this would be to enforce #[deny(missing_docs)] at the crate level for each of our crates and then work through all the compile errors. Prob a big effort but will dramatically improve @rajkaramchedu's effort to improve the subtensor docs, and will require us to document things going forward as we create them.

AC:

  • add #[deny(missing_docs)] to all subtensor crates
  • fix the resulting compile errors, upgrading any // item-level comments to /// and ensuring they do not introduce any broken doc links
  • cargo doc --workspace passing without any broken doc links
@sam0x17 sam0x17 added the documentation Improvements or additions to documentation label Apr 8, 2024
@sam0x17 sam0x17 self-assigned this Apr 8, 2024
@sam0x17 sam0x17 removed their assignment May 6, 2024
@open-junius open-junius self-assigned this May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants