Repeated capability documentation explains implementation details
Open
Nobody has claimed this yet.
docs
priority-low
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Our public documentation for repeated capabilities contains text like:
passes a string of :python:'0, 1, 2' to the set attribute function.
nimi-python customer should not care nor need to care how the API interacts with the driver runtime. We should document visible behavior only.
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 searching the public documentation for the quoted implementation-detail text and other repeated-capability descriptions. Update the affected passages so they describe only visible API behavior, then review the documentation for remaining driver-runtime details.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100