Skip to content

Commit 7a5c06b

Browse files
authored
Update io_developers_guide.rst
fix typos.
1 parent 93a99d0 commit 7a5c06b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/source/io_developers_guide.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ For read/write classes you can mix the two levels neo.rawio for reading and neo.
2222

2323
Recipe to develop an IO module for a new data format:
2424
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.
2626
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)
2828
5. Write good docstrings. List dependencies, including minimum version numbers.
2929
6. Add your class to :mod:`neo.rawio.__init__`. Keep imports inside ``try/except`` for dependency reasons.
3030
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
5252
These tests:
5353

5454
* 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.
5656

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/``.
5858
Subsequent test runs use the previously downloaded files, rather than trying to download them each time.
5959

6060
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
7070
Logging
7171
=======
7272

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.
7474
The logger name is the same as the fully qualified class name, e.g. :class:`neo.io.nixio.NixIO`.
7575
The :attr:`class.logger` attribute holds the logger for easy access.
7676

0 commit comments

Comments
 (0)