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

Review code documentation #315

Open
dblnz opened this issue Mar 4, 2025 · 0 comments
Open

Review code documentation #315

dblnz opened this issue Mar 4, 2025 · 0 comments
Labels
area/documentation Improvements or additions to documentation lifecycle/needs review
Milestone

Comments

@dblnz
Copy link
Contributor

dblnz commented Mar 4, 2025

The documentation in the code should be reviewed to ensure it is up to date with the code it describes.
This is particularly helpful for newcomers as sometimes understanding what and why is happening in some parts of the codebase can require additional information.

This can/should be split into multiple smaller issues to address specific parts of the codebase.

@dblnz dblnz added the area/documentation Improvements or additions to documentation label Mar 4, 2025
@danbugs danbugs added this to the Backlog milestone Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation lifecycle/needs review
Projects
Status: No status
Development

No branches or pull requests

2 participants