Documentation: expose missing docstrings for csp objects
Open
Nobody has claimed this yet.
part: documentation
- Dominant language
- Python
- Stars
- 441
- Forks
- 90
- Avg merge
- 1d 12m
- Merged PRs (30d)
- 5
Description
For example, csp.ticked is mentioned but could benefit from having its docstring exposed. This is probably true for other objects as well.
We can use this issue to capture a list of objects that need to be documented better.
Contributor guide
No contributing guide indexed for this repository
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
Start by locating the Python definitions and documentation exposure for csp.ticked, then inspect related csp objects for missing docstrings. Use the issue to record the objects that need better documentation; the work is done when the relevant missing docstrings are exposed and the list is addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100