Incorrect documentation for the channel_name parameter of niFgen.Session
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
Description of issue
In the documentation for niFgen.Session the parameter channel_name is listed as having a default value of 'None':
Further down in the documentation, channel_name is listed as having a default value of '0':
My understanding is that these are two different things -- on a two-channel device, a default value of '0' would indicate a session contained only channel 0, whereas a value of None would indicate it contained all channels (same as leaving the terminal unwired or wired to a blank string in LabVIEW).
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 niFgen.Session documentation entries for the channel_name parameter and compare the two stated defaults with the documented or implemented API behavior. Done means the conflicting entries are reconciled and the documentation clearly describes the correct default and its channel-selection semantics.
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
- 35/100