code doc typo fixes

Author: TomDonoghue

neo/core/analogsignal.py

@@ -2,7 +2,7 @@
 This module implements :class:`AnalogSignal`, an array of analog signals.
 
 :class:`AnalogSignal` inherits from :class:`basesignal.BaseSignal` which
-derives from :class:`BaseNeo`, and from :class:`quantites.Quantity`which
+derives from :class:`BaseNeo`, and from :class:`quantities.Quantity`which
 in turn inherits from :class:`numpy.array`.
 
 Inheritance from :class:`numpy.array` is explained here:

neo/core/basesignal.py

@@ -311,4 +311,4 @@ def concatenate(self, *signals):
             If `other` object has incompatible attributes.
         '''
 
-        NotImplementedError('Patching need to be implemented in sublcasses')
+        NotImplementedError('Patching need to be implemented in subclasses')

neo/core/block.py

@@ -1,6 +1,6 @@
 '''
 This module defines :class:`Block`, the main container gathering all the data,
-whether discrete or continous, for a given recording session. base class
+whether discrete or continuous, for a given recording session. base class
 used by all :module:`neo.core` classes.
 
 :class:`Block` derives from :class:`Container`,
@@ -14,7 +14,7 @@
 
 class Block(Container):
     '''
-    Main container gathering all the data, whether discrete or continous, for a
+    Main container gathering all the data, whether discrete or continuous, for a
     given recording session.
 
     A block is not necessarily temporally homogeneous, in contrast to :class:`Segment`.
@@ -78,7 +78,7 @@ def __init__(self, name=None, description=None, file_origin=None,
                  file_datetime=None, rec_datetime=None, index=None,
                  **annotations):
         '''
-        Initalize a new :class:`Block` instance.
+        Initialize a new :class:`Block` instance.
         '''
         super().__init__(name=name, description=description,
                                     file_origin=file_origin, **annotations)

neo/core/container.py

@@ -228,7 +228,7 @@ class Container(BaseNeo):
     def __init__(self, name=None, description=None, file_origin=None,
                  **annotations):
         """
-        Initalize a new :class:`Container` instance.
+        Initialize a new :class:`Container` instance.
         """
         super().__init__(name=name, description=description,
                          file_origin=file_origin, **annotations)
@@ -466,7 +466,7 @@ def create_many_to_one_relationship(self, force=False, recursive=True):
         that this method will link up.
 
         If force is True overwrite any existing relationships
-        If recursive is True desecend into child objects and create
+        If recursive is True descend into child objects and create
         relationships there
         """
         parent_name = _reference_name(self.__class__.__name__)
@@ -485,7 +485,7 @@ def create_many_to_many_relationship(self, append=True, recursive=True):
         of this type, put the current object in the parent list.
 
         If append is True add it to the list, otherwise overwrite the list.
-        If recursive is True desecend into child objects and create
+        If recursive is True descend into child objects and create
         relationships there
         """
         parent_name = _container_name(self.__class__.__name__)
@@ -517,7 +517,7 @@ def create_relationship(self, force=False, append=True, recursive=True):
 
         If force is True overwrite any existing relationships
         If append is True add it to the list, otherwise overwrite the list.
-        If recursive is True desecend into child objects and create
+        If recursive is True descend into child objects and create
         relationships there
         """
         self.create_many_to_one_relationship(force=force, recursive=False)

neo/core/dataobject.py

@@ -124,7 +124,7 @@ def _check_single_elem(element):
 
             # Check the first element for correctness
             # If its type is correct for annotations, all others are correct as well
-            # Note: Emtpy lists cannot reach this point
+            # Note: Empty lists cannot reach this point
             _check_single_elem(value[0])
 
     return value

neo/core/imagesequence.py

@@ -2,7 +2,7 @@
 This module implements :class:`ImageSequence`, a 3D array.
 
 :class:`ImageSequence` inherits from :class:`basesignal.BaseSignal` which
-derives from :class:`BaseNeo`, and from :class:`quantites.Quantity`which
+derives from :class:`BaseNeo`, and from :class:`quantities.Quantity`which
 in turn inherits from :class:`numpy.array`.
 
 Inheritance from :class:`numpy.array` is explained here:

neo/core/segment.py

@@ -20,7 +20,7 @@ class Segment(Container):
     '''
     A container for data sharing a common time basis.
 
-    A :class:`Segment` is a heterogeneous container for discrete or continous
+    A :class:`Segment` is a heterogeneous container for discrete or continuous
     data sharing a common clock (time basis) but not necessary the same
     sampling rate, start or end time.
 

neo/core/spiketrain.py

@@ -2,7 +2,7 @@
 This module implements :class:`SpikeTrain`, an array of spike times.
 
 :class:`SpikeTrain` derives from :class:`BaseNeo`, from
-:module:`neo.core.baseneo`, and from :class:`quantites.Quantity`, which
+:module:`neo.core.baseneo`, and from :class:`quantities.Quantity`, which
 inherits from :class:`numpy.array`.
 
 Inheritance from :class:`numpy.array` is explained here:
@@ -261,13 +261,13 @@ def __new__(cls, times, t_stop, units=None, dtype=None, copy=True, sampling_rate
                 t_start=0.0 * pq.s, waveforms=None, left_sweep=None, name=None, file_origin=None,
                 description=None, array_annotations=None, **annotations):
         '''
-        Constructs a new :clas:`Spiketrain` instance from data.
+        Constructs a new :class:`Spiketrain` instance from data.
 
         This is called whenever a new :class:`SpikeTrain` is created from the
         constructor, but not when slicing.
         '''
         if len(times) != 0 and waveforms is not None and len(times) != waveforms.shape[0]:
-            # len(times)!=0 has been used to workaround a bug occuring during neo import
+            # len(times)!=0 has been used to workaround a bug occurring during neo import
             raise ValueError("the number of waveforms should be equal to the number of spikes")
 
         if dtype is not None and hasattr(times, 'dtype') and times.dtype != dtype:
@@ -382,7 +382,7 @@ def __array_finalize__(self, obj):
         constructor, and these are set in __new__. Then they are just
         copied over here.
 
-        Note that the :attr:`waveforms` attibute is not sliced here. Nor is
+        Note that the :attr:`waveforms` attribute is not sliced here. Nor is
         :attr:`t_start` or :attr:`t_stop` modified.
         '''
         # This calls Quantity.__array_finalize__ which deals with

neo/rawio/alphaomegarawio.py

@@ -102,7 +102,7 @@ def __init__(self, dirname="", lsx_files=None, prune_channels=True):
 
     def _explore_folder(self):
         """
-        If class was instanciated with lsx_files (list of .lsx files), load only
+        If class was instantiated with lsx_files (list of .lsx files), load only
         the files referenced in these lsx files otherwise, load all *.mpx files
         in `dirname`.
         It does not explores the subfolders.
@@ -114,7 +114,7 @@ def _explore_folder(self):
                 with open(index_file, "r") as f:
                     for line in f:
                         # a line is a Microsoft Windows path. As we cannot
-                        # instanciate a WindowsPath on other OS than MS
+                        # instantiate a WindowsPath on other OS than MS
                         # Windows, we use the PureWindowsPath class
                         filename = PureWindowsPath(line.strip())
                         filename = self.dirname / filename.name
@@ -145,7 +145,7 @@ def _read_file_datablocks(self, filename, prune_channels=True):
         :param prune_channels: Remove references to channels and ports which
             doesn't contain any data recorded. Be careful when using this option
             with multiple-file data since it could theoretically leads to
-            expection raised when data recorded in further files are merged into
+            exception raised when data recorded in further files are merged into
             the first file pruned from these channels.
         :type prune_channels: bool
         """
@@ -1127,7 +1127,7 @@ def get_name(f, name_length):
     - mode_spike (2 bytes): read as hex data 0xMCCC:
         - M: 1=Master, 2=Slave
         - CCC: linked channel
-        Be carefull here, the first byte cover MC and the second byte the last
+        Be careful here, the first byte cover MC and the second byte the last
         part of the linked channel CC
 """
 SDefContinAnalog = struct.Struct("<fh")

neo/rawio/axographrawio.py

@@ -66,7 +66,7 @@
     data appears before the second column's. As an aside, because of this
     design choice AxoGraph cannot write data to disk as it is collected but
     must store it all in memory until data acquisition ends. This also affected
-    how file slicing was implmented for this RawIO: Instead of using a single
+    how file slicing was implemented for this RawIO: Instead of using a single
     memmap to address into a 2-dimensional block of data, AxographRawIO
     constructs multiple 1-dimensional memmaps, one for each column, each with
     its own offset.
@@ -127,7 +127,7 @@
     Segments in Neo. Certain criteria have to be met, such as all groups
     containing equal numbers of traces and each group having homogeneous signal
     parameters. If trace grouping was modified by the user after data
-    acquisition, this may result in the file being interpretted as
+    acquisition, this may result in the file being interpreted as
     non-episodic. Older versions of the AxoGraph file format lack group headers
     entirely, so these files are never deemed safe to interpret as episodic,
     even if the column names follow a repeating sequence as described above.
@@ -397,7 +397,7 @@ def _rescale_epoch_duration(self, raw_duration, dtype, event_channel_index):
 
     def _safe_to_treat_as_episodic(self):
         """
-        The purpose of this fuction is to determine if the file contains any
+        The purpose of this function is to determine if the file contains any
         irregularities in its grouping of traces such that it cannot be treated
         as episodic. Even "continuous" recordings can be treated as
         single-episode recordings and could be identified as safe by this
@@ -627,7 +627,7 @@ def _scan_axograph_file(self):
                 # COLUMN TYPE
 
                 # depending on the format version, data columns may have a type
-                # - prior to verion 3, column types did not exist and data was
+                # - prior to version 3, column types did not exist and data was
                 #   stored in a fixed pattern
                 # - beginning with version 3, several data types are available
                 #   as documented in AxoGraph_ReadWrite.h