You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/source/io_developers_guide.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,9 @@ For read/write classes you can mix the two levels neo.rawio for reading and neo.
22
22
23
23
Recipe to develop an IO module for a new data format:
24
24
1. Fully understand the object model. See :doc:`core`. If in doubt ask the `mailing list`_.
25
-
2. Fully understand :mod:`neo.rawio.examplerawio`, It is a fake IO to explain the API. If in doubt ask the list.
25
+
2. Fully understand :mod:`neo.rawio.examplerawio`. It is a fake IO to explain the API. If in doubt ask the list.
26
26
3. Copy/paste ``examplerawio.py`` and choose clear file and class names for your IO.
27
-
4. implement all methods that **raise(NotImplementedError)** in :mod:`neo.rawio.baserawio`. Return None when the object is not supported (spike/waveform)
27
+
4. Implement all methods that **raise(NotImplementedError)** in :mod:`neo.rawio.baserawio`. Return None when the object is not supported (spike/waveform)
28
28
5. Write good docstrings. List dependencies, including minimum version numbers.
29
29
6. Add your class to :mod:`neo.rawio.__init__`. Keep imports inside ``try/except`` for dependency reasons.
30
30
7. Create a class in :file:`neo/io/`
@@ -52,9 +52,9 @@ To use these you need to upload some sample data files at `gin-gnode`_. They wil
52
52
These tests:
53
53
54
54
* check the compliance with the schema: hierarchy, attribute types, ...
55
-
* For IO modules able to both write and read data, it compares a generated dataset with the same data after a write/read cycle.
55
+
* For IO modules confirms it is able to both write and read data; they compare a generated dataset with the same data after a write/read cycle.
56
56
57
-
The test scripts download all files from `gin-gnode`_ and stores them locally in ``/tmp/files_for_tests/``.
57
+
The test scripts download all files from `gin-gnode`_ and store them locally in ``/tmp/files_for_tests/``.
58
58
Subsequent test runs use the previously downloaded files, rather than trying to download them each time.
59
59
60
60
Each test must have at least one class that inherits ``BaseTestRawIO`` and that has 3 attributes:
@@ -70,7 +70,7 @@ Here is an example test script taken from the distribution: :file:`test_axonrawi
70
70
Logging
71
71
=======
72
72
73
-
All IO classes by default have logging using the standard :mod:`logging` module: already set up.
73
+
All IO classes by default have logging using the standard :mod:`logging` module already set up.
74
74
The logger name is the same as the fully qualified class name, e.g. :class:`neo.io.nixio.NixIO`.
75
75
The :attr:`class.logger` attribute holds the logger for easy access.
0 commit comments