Skip to content

Commit 93a99d0

Browse files
authored
Update io.rst
fixed a couple typos and added (ram) to 133 since plenty of people confuse storage and memory
1 parent 771f1de commit 93a99d0

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/source/io.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Read a time slice of Segment
114114

115115
Some objects support the ``time_slice`` argument in ``read_segment()``.
116116
This is useful to read only a subset of a dataset clipped in time.
117-
By default ``time_slice=None`` meaning load everything.
117+
By default ``time_slice=None`` will load everything.
118118

119119
This reads everything::
120120

@@ -130,7 +130,7 @@ This reads only the first 5 seconds::
130130
Lazy option and proxy objects
131131
=============================
132132

133-
In some cases you may not want to load everything in memory because it could be too big.
133+
In some cases you may not want to load everything in memory (RAM) because it could be too big.
134134
For this scenario, some IOs implement ``lazy=True/False``.
135135
Since neo 0.7, a new lazy system has been added for some IO modules (all IO classes that inherit from rawio).
136136
To know if a class supports lazy mode use ``ClassIO.support_lazy``.
@@ -144,12 +144,12 @@ These proxy objects contain metadata (name, sampling_rate, id, ...) so they can
144144
but they do not contain any array-like data.
145145
All proxy objects contain a ``load()`` method to postpone the real load of array like data.
146146

147-
Further more the ``load()`` method has a ``time_slice`` argument to load only a slice
147+
Furthermore the ``load()`` method has a ``time_slice`` argument to load only a slice
148148
from the file. In this way the consumption of memory can be finely controlled.
149149

150150

151151
Here are two examples that read a dataset, extract sections of the signal based on recorded events,
152-
and averages the sections.
152+
and average the sections.
153153

154154
The first example is without lazy mode, so it consumes more memory::
155155

@@ -178,7 +178,7 @@ The second example uses lazy mode, so it consumes less memory::
178178
apply_my_fancy_average(all_sig_chunks)
179179

180180
In addition to ``time_slice``, AnalogSignalProxy supports the ``channel_indexes`` argument.
181-
This allows loading only a subset of channels. This is useful where the channel count is very high.
181+
This allows loading only a subset of channels. This is useful when the channel count is very high.
182182

183183
.. TODO: add something about magnitude mode when implemented for all objects.
184184
@@ -295,7 +295,7 @@ For more complex logging, please see the documentation for the logging_ module.
295295

296296
.. note:: If you wish to implement more advanced logging as describe in the documentation for the logging_ module or elsewhere on the internet, please do so before calling any :mod:`neo` functions or initializing any :mod:`neo` classes.
297297
This is because the default handler is created when :mod:`neo` is imported, but it is not attached to the :mod:`neo` logger until a class that uses logging is initialized or a function that uses logging is called.
298-
Further, the handler is only attached if there are no handlers already attached to the root logger or the :mod:`neo` logger, so adding your own logger will override the default one.
298+
Furthermore, the handler is only attached if there are no handlers already attached to the root logger or the :mod:`neo` logger, so adding your own logger will override the default one.
299299
Additional functions and/or classes may get logging during bugfix releases, so code relying on particular modules not having logging may break at any time without warning.
300300

301301
.. _`logging`: https://docs.python.org/3/library/logging.html

0 commit comments

Comments
 (0)