Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Require all public symbols be documented #33

Open
Notgnoshi opened this issue Nov 19, 2023 · 0 comments
Open

Require all public symbols be documented #33

Notgnoshi opened this issue Nov 19, 2023 · 0 comments
Labels
ci/cd Related to automated pipelines documentation Improvements or additions to documentation

Comments

@Notgnoshi
Copy link
Member

Notgnoshi commented Nov 19, 2023 •
edited
Loading

Motivated by #30 (reply in thread)

It appears we can achieve this through judicious use of #[warn(missing_docs)] and the existing use of -Dwarnings in the CI/CD pipeline. https://doc.rust-lang.org/rustdoc/write-documentation/what-to-include.html
@Notgnoshi Notgnoshi added documentation Improvements or additions to documentation ci/cd Related to automated pipelines labels Nov 19, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
ci/cd Related to automated pipelines documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Notgnoshi