Ensure optional annotations are not set to None
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Ensure optional annotations are not set to None (and possible "n/a"). Instead, the annotation should just be dropped altogether if not needed. This applies to specific annotations where None is not a valid value (e.g. toggle_warning).
This just leads to messy docs that could be cleaner, so it us unlikely to be as urgent as other issues.
See example of where None is copied often and leads to a lot of extra code and useless docs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the repository for the annotation handling and the toggle_warning annotation, then inspect how optional values such as None or "n/a" are copied into documentation. Confirm the intended behavior from the linked pull-request discussion. Done means unsupported optional annotations are omitted rather than emitted with invalid values, with coverage for the affected cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100