Update doc strings: optional
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 23
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
There was an inconsistent use of the word "optional" in our doc strings. Currently an Optional type and an argument with a default both get coded as (XXX, optional).
Moving forward, any argument with a default will just be indicated in the expression (XXX): This parameter does blah. It defaults to blah. Optional types will be denoted via (Optional[XXX]). We will remove all uses of (YYY, optional).
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's Python docstrings for uses of (XXX, optional) and review each occurrence against whether the argument has a default or an Optional type. Update the documentation to use the specified notation, then verify that no outdated (YYY, optional) usages remain.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100