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

Fix docutil parsing errors in code base #1629

Merged
merged 2 commits into from
Jan 18, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion neo/core/segment.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ class Segment(Container):
Notes
-----

*Container of*:
Container of:
:class:`Epoch`
:class:`Event`
:class:`AnalogSignal`
Expand Down
2 changes: 1 addition & 1 deletion neo/rawio/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@

.. autoclass:: neo.rawio.NeuroNexusRawIO

.. autoattributes:: extensions
.. autoattribute:: extensions

.. autoclass:: neo.rawio.NeuroScopeRawIO

Expand Down
6 changes: 6 additions & 0 deletions neo/rawio/intanrawio.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,13 @@
RHD headerless binary support 3.x
RHS headerless binary support 3.x


See:

* http://intantech.com/files/Intan_RHD2000_data_file_formats.pdf
* http://intantech.com/files/Intan_RHS2000_data_file_formats.pdf


Author: Samuel Garcia (Initial), Zach McKenzie & Heberto Mayorquin (Updates)

"""
Expand Down Expand Up @@ -50,6 +53,7 @@ class IntanRawIO(BaseRawIO):
check we perform is that timestamps are continuous. Setting this to True will ignore this check and set
the attribute `discontinuous_timestamps` to True if the timestamps are not continous. This attribute can be checked
after parsing the header to see if the timestamps are continuous or not.

Notes
-----
* The Intan reader can handle two file formats 'rhd' and 'rhs'. It will automatically
Expand All @@ -67,6 +71,7 @@ class IntanRawIO(BaseRawIO):
* Intan files contain amplifier channels labeled 'A', 'B' 'C' or 'D'
depending on the port in which they were recorded along with the following
additional streams.

0: 'RHD2000' amplifier channel
1: 'RHD2000 auxiliary input channel',
2: 'RHD2000 supply voltage channel',
Expand All @@ -88,6 +93,7 @@ class IntanRawIO(BaseRawIO):
one long vector, which must be post-processed to extract individual digital channel information.
See the intantech website for more information on performing this post-processing.


Examples
--------
>>> import neo.rawio
Expand Down
Loading