Remove underlying values from documentation of enums
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
Python users don't need to know the underlying value used when passing an enum method parameter or property down to C DLLs. We should remove these values from user documentation. e.g. See event_id table in https://nimi-python.readthedocs.io/en/master/nidcpower/class.html#wait-for-event
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
Open the linked wait-for-event event_id table first and trace it to the documentation source in nimi-python. Remove the displayed underlying enum values while retaining the enum names and usage guidance; done when the affected user documentation no longer exposes those values.
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
- 45/100