search

ni / nimi-python

Python bindings for NI Modular Instrument drivers.
Other
112 stars 84 forks source link

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

Open gfisher-NI opened 11 months ago

gfisher-NI commented 11 months ago

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

ni-jfitzger commented 11 months ago

@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 commented 11 months ago

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