Documentation for enum values is missing
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
There are numerous enum values (e.g. nidcpower.Event, nifgen.HardwareState, niscope.ClearableMeasurement) that are missing documentation
Originally posted by @phindman in https://github.com/ni/nimi-python/issues/1555#issuecomment-776915329
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 locating the documentation for the named enums: nidcpower.Event, nifgen.HardwareState, and niscope.ClearableMeasurement. Identify which enum values lack documentation and document the missing values across the affected APIs; done means the listed omissions and other missing enum-value documentation are covered.
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