Use the correct term for NI-FGEN and NI-SCOPE devices
Open
Nobody has claimed this yet.
docs
nifgen
niscope
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
NI-FGEN devices are referred to as Signal Generators. The correct term is Waveform Generators. Usages:
NI-SCOPE devices are referred to as High Speed Digitizers. The correct term is Oscilloscopes. Usages:
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 referenced lines in src/nifgen/metadata/config.py and src/niscope/metadata/config.py, then inspect the linked NI-SCOPE and nimodinst documentation usage pages. Update the terminology so NI-FGEN devices are called Waveform Generators and NI-SCOPE devices are called Oscilloscopes wherever these usages appear.
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
- Clearly specified
- Newbie friendliness
- 50/100