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

CI should fail if public APIs are missing documentation or if the documentation has detectable problems #332

Open
jeffcharles opened this issue Apr 27, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@jeffcharles
Copy link
Collaborator

What is the idea?

We should build the docs as part of CI to ensure the process succeeds.

rustc has a missing_docs lint that we could set to deny. rustdocs also has a set of lints that can be set up to emit errors if they're violated. These two changes would help catch mistakes in the public documentation.

These lints can be enabled at as part of each crate in src/lib.rs or as command-line arguments to various cargo commands, perhaps through the Makefile.

What problem does it solve?

It would be helpful to know when someone has forgotten to add documentation to a public member in a PR or if there are issues detectable by rustdoc with the docs that should be corrected.

@jeffcharles jeffcharles added the enhancement New feature or request label Apr 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant