Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect documentation for the channel_name parameter of niFgen.Session #2024

Open
gfisher-NI opened this issue Sep 25, 2023 · 2 comments
Open

Comments

@gfisher-NI
Copy link
Contributor

Description of issue

In the documentation for niFgen.Session the parameter channel_name is listed as having a default value of 'None':
image

Further down in the documentation, channel_name is listed as having a default value of '0':
image

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).

@gfisher-NI gfisher-NI changed the title Incorrect documentation for the channel_name parameter of niFgen. Incorrect documentation for the channel_name parameter of niFgen.Session Sep 25, 2023
@ni-jfitzger
Copy link
Collaborator

@gfisher-NI thank you for filing a public issue so that users can be aware of this mistake.

If you haven't already, I recommend you also file an internal bug. This description was taken from the niFgen_InitializeWithIndependentChannels documentation in the C Reference and it doesn't appear to have changed.

@gfisher-NI
Copy link
Contributor Author

@ni-jfitzger Will do! I just know the preference is to open issues involving Python here, first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants