Fix issues with enums in NI-SCOPE documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
For a number of the newly added properties in the NI-SCOPE measurement library, enums which are referenced in the property documentation have strange results when run through the codegen replacement. For example, meas_fir_filter_window references the ArrayMeasurement enum mistakenly, and meas_percentage_method doesn't replace the default NISCOPE_* with correctly formatted enum references.
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 with the generated niscope/niscope/session.py entries for meas_fir_filter_window around line 841 and meas_percentage_method around line 914. Trace the codegen replacement that produces their enum documentation and compare the results with the referenced NI-SCOPE enums; done means both properties show the correctly formatted enum references rather than ArrayMeasurement or unreplaced NISCOPE_* names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100