cityofaustin / cityofaustin/techstack
docstring all the things
- Dominant language
- No language data
- Stars
- 11
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Lack of documentation/code comments is a big issue with the Joplin codebase
Lets go through all our models and snippets and add docstrings that describe what they are for and how they work. If we can't answer that than we need to find a way to. If we find redundant comments on similar objects, we should be able to describe why they are that way.
Contributor guide
No contributing guide indexed for this repository
Research direction
No files, tests, or entry points are named. Begin by identifying the repository's models and snippets, then document each object's purpose and behavior; done means the requested objects have useful docstrings and any redundant comments explain their differences.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100