Skip to content

Commit 0365881

Browse files
authored
Fix nidigital.get_channel_names documentation (#1631)
1 parent f447cef commit 0365881

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/nidigital/class.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1556,7 +1556,7 @@ get_channel_names
15561556
15571557
.. py:method:: get_channel_names(indices)
15581558
1559-
Returns a comma-separated list of channel names from a string index list.
1559+
Returns a list of channel names for given channel indices.
15601560
15611561
15621562
@@ -1582,7 +1582,7 @@ get_channel_names
15821582
:return:
15831583
15841584
1585-
The returned channel name(s) at the specified index.
1585+
The channel name(s) at the specified indices.
15861586
15871587
15881588

generated/nidigital/nidigital/session.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2627,7 +2627,7 @@ def _get_attribute_vi_string(self, attribute):
26272627
def get_channel_names(self, indices):
26282628
r'''get_channel_names
26292629
2630-
Returns a comma-separated list of channel names from a string index list.
2630+
Returns a list of channel names for given channel indices.
26312631
26322632
Args:
26332633
indices (basic sequence types or str or int): Index list for the channels in the session. Valid values are from zero to the total number of channels in the session minus one. The index string can be one of the following formats:
@@ -2640,7 +2640,7 @@ def get_channel_names(self, indices):
26402640
26412641
26422642
Returns:
2643-
names (list of str): The returned channel name(s) at the specified index.
2643+
names (list of str): The channel name(s) at the specified indices.
26442644
26452645
'''
26462646
vi_ctype = _visatype.ViSession(self._vi) # case S110

src/nidigital/metadata/functions.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1962,7 +1962,7 @@
19621962
},
19631963
'GetChannelNameFromString': {
19641964
'documentation': {
1965-
'description': 'Returns a comma-separated list of channel names from a string index list.\n'
1965+
'description': 'Returns a list of channel names for given channel indices.\n'
19661966
},
19671967
'parameters': [
19681968
{
@@ -1994,7 +1994,7 @@
19941994
{
19951995
'direction': 'out',
19961996
'documentation': {
1997-
'description': 'The returned channel name(s) at the specified index.\n'
1997+
'description': 'The channel name(s) at the specified indices.\n'
19981998
},
19991999
'name': 'names',
20002000
'python_api_converter_name': 'convert_comma_separated_string_to_list',

0 commit comments

Comments
 (0)