Internal-only API reference for 'contributing' docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 150
- Forks
- 23
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 2
Description
Only the public API is generally documented in the API reference, but for developers, those building libraries using cf-python, and anyone else potentially keen to know more about what goes on under-the-hood, without having to search through the codebase, it could be useful to have some developer documentation containing the API reference for internal objects. A sensible place to house that would be in some hierarchy under the existing 'Contributing' section.
See also https://github.com/NCAS-CMS/cf-python/pull/210#issuecomment-842324749 where a reference for the mixin classes is given as an example that could be useful.
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 by reviewing the existing Contributing documentation and the mixin-class API reference example linked from pull request 210. Define the appropriate hierarchy for internal-object API references and document the relevant internal objects there; done means developers can consult this reference without searching the codebase.
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