Skip to content

Commit 6c555a3

Browse files
zm711h-mayorquin
andauthored
Docs: Update ID language for RawIO (#1915)
* update ID language * Heberto feedback * heberto feedback II Co-Authored-By: Heberto Mayorquin <h.mayorquin@gmail.com> --------- Co-authored-by: Heberto Mayorquin <h.mayorquin@gmail.com>
1 parent edd0fd0 commit 6c555a3

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

‎doc/source/rawio.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,10 @@ Read chunks of signal data and scale them
146146
In [14]: sampling_rate, t_start, units
147147
Out[14]: (1000.0, 0.0, '')
148148

149-
There are 3 ways to select a subset of channels: by index (0 based), by id or by name.
150-
By index is unambiguous 0 to n-1 (inclusive), whereas for some IOs channel_names
151-
(and sometimes channel_ids) are not guaranteed to be unique.
152-
In such cases, using names or ids may raise an error.
149+
There are 3 ways to select a subset of channels: by index (0-based), by id (IO-specific numbering scheme) or by name (IO-specific naming scheme).
150+
By index is unambiguous 0 to n-1 (inclusive), ids are unambiguous (though each IO may use a different scheme), by channel name is often unique, but this is not guaranteed.
151+
In general it is safest to use ids as they are guaranteed to be unique and are specific to the IO. Indexes are positional and only stable within a given version of Neo;
152+
a reader update (for example adding digital channels) can change which channel an index points to. If your code needs to work across Neo versions, select by id.
153153

154154
A selected subset of channels which is passed to :func:`get_analog_signal_chunk()`, :func:`get_analog_signal_size()`,
155155
or :func:`get_analog_signal_t_start()` has the additional restriction that all such channels must have

0 commit comments

Comments
 (0)