Address API documentation summary line TODOs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 150
- Forks
- 23
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 2
Description
All methods should at least have a summary line to outline their basic purpose or usage. Currently this is not the case leaving the rationale for methods such as Field.get_coordinate_reference (as noted in #239) potentially unclear.
As a crude estimate of the number of methods undocumented minimally, git grep '"""TODO' | wc -l under the cf/ dir gives 99 for the state of the codebase at time of making this comment (with the equivalent for "'''TODO" not required as black enforces double-quote marks for docstrings etc.). So ~100 methods need summarising. That's small enough to tackle for the next release, easily.
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
Start under the cf/ directory by running git grep '"""TODO' | wc -l to locate methods lacking summary docstrings. Read each affected method, including Field.get_coordinate_reference, to understand its basic purpose and usage. Done means the TODO docstrings have concise summary lines and the remaining count 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
- Mostly clear
- Newbie friendliness
- 45/100