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

Lint missing public API docs #588

Open
niklasdewally opened this issue Jan 13, 2025 · 0 comments
Open

Lint missing public API docs #588

niklasdewally opened this issue Jan 13, 2025 · 0 comments

Comments

@niklasdewally
Copy link
Collaborator

It might be a good idea to lint for missing public API documentation by adding the following to our lib.rs files:

#![warn(missing_docs)]

This could also help us improve our public API by finding things that are public that should instead be private / pub(crate) / #[doc(hidden)].

Given that we have many documentation holes at the moment, we shouldn't add it straight away, but I think in the long term it would be a good check to have in CI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant