Code generation misses substitution in NI-SCOPE meas_filter_type attribute documentation.
Open
Nobody has claimed this yet.
docs
niscope
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
In NI-SCOPE's meas_filter_type documentation, the allowed values should reference the FIlterTypes enum, which is correctly generated in the code, but the documentation instead shows non-substituted values such as "~niscope.NISCOPE_VAL_MEAS_LOWPASS".
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
The issue identifies NI-SCOPE's meas_filter_type documentation and the generated FIlterTypes enum; start by locating those generated outputs and the code-generation path that produces the attribute docs. Compare the documentation's substituted values with the enum, and consider the work done when the docs reference the enum values rather than literal ~niscope... names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100