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

Small number of doc comments in the project #1632

Open
laruh opened this issue Jan 26, 2023 · 0 comments
Open

Small number of doc comments in the project #1632

laruh opened this issue Jan 26, 2023 · 0 comments
Assignees

Comments

@laruh
Copy link
Member

laruh commented Jan 26, 2023

The code base of the project has grown a lot over the years, so I think it's worth covering the project with doc comments to be able to generate a more detailed code documentation.

To check for doc comments, we can add missing_docs lint in CI. It detects missing documentation for public items.

There is also clippy linter missing_docs_in_private_items which warns for all items. The more comments the better, but this approach can have a negative impact on development speed.

First we need to check how long it takes to add doc comments for public items.

@laruh laruh self-assigned this Jan 26, 2023
@shamardy shamardy assigned mariocynicys and unassigned laruh Feb 12, 2024
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

2 participants