docstrings

Author: apdavison

neo/core/block.py

@@ -96,19 +96,19 @@ def __init__(self, name=None, description=None, file_origin=None,
     segments = property(
         fget=lambda self: self._get_object_list("_segments"),
         fset=lambda self, value: self._set_object_list("_segments", value),
-        doc="todo"
+        doc="list of Segments contained in this block"
     )
 
     groups = property(
         fget=lambda self: self._get_object_list("_groups"),
         fset=lambda self, value: self._set_object_list("_groups", value),
-        doc="todo"
+        doc="list of Groups contained in this block"
     )
 
     regionsofinterest = property(
         fget=lambda self: self._get_object_list("_regionsofinterest"),
         fset=lambda self, value: self._set_object_list("_regionsofinterest", value),
-        doc="todo"
+        doc="list of RegionOfInterest objects contained in this block"
     )
 
     @property

neo/core/container.py

@@ -197,13 +197,19 @@ def __init__(self, name=None, description=None, file_origin=None,
 
     def _get_object_list(self, name):
         """
-        todo
+        Return the container's ObjectList with the given (private) attribute name
+
+        Example:
+        >>> segment._get_object_list("_analogsignals")
         """
         return getattr(self, name)
 
     def _set_object_list(self, name, value):
         """
-        todo
+        Set the contents of the container's ObjectList with the given (private) attribute name
+
+        Example:
+        >>> segment._set_object_list("_analogsignals", [sig1, sig2])
         """
         assert isinstance(value, list)
         object_list = getattr(self, name)

neo/core/group.py

@@ -83,43 +83,44 @@ def __init__(self, objects=None, name=None, description=None, file_origin=None,
     analogsignals = property(
         fget=lambda self: self._get_object_list("_analogsignals"),
         fset=lambda self, value: self._set_object_list("_analogsignals", value),
-        doc="todo"
+        doc="list of AnalogSignals contained in this group"
     )
 
     irregularlysampledsignals = property(
         fget=lambda self: self._get_object_list("_irregularlysampledsignals"),
         fset=lambda self, value: self._set_object_list("_irregularlysampledsignals", value),
-        doc="todo"
+        doc="list of IrregularlySignals contained in this group"
     )
 
     events = property(
         fget=lambda self: self._get_object_list("_events"),
         fset=lambda self, value: self._set_object_list("_events", value),
-        doc="todo"
+        doc="list of Events contained in this group"
     )
 
     epochs = property(
         fget=lambda self: self._get_object_list("_epochs"),
         fset=lambda self, value: self._set_object_list("_epochs", value),
-        doc="todo"
+        doc="list of Epochs contained in this group"
     )
 
     channelviews = property(
         fget=lambda self: self._get_object_list("_channelviews"),
         fset=lambda self, value: self._set_object_list("_channelviews", value),
-        doc="todo"
+        doc="list of ChannelViews contained in this group"
     )
 
     imagesequences = property(
         fget=lambda self: self._get_object_list("_imagesequences"),
         fset=lambda self, value: self._set_object_list("_imagesequences", value),
-        doc="todo"
+        doc="list of ImageSequences contained in this group"
     )
 
     spiketrains = property(
         fget=lambda self: self._get_object_list("_spiketrains"),
         fset=lambda self, value: self._set_object_list("_spiketrains", value),
-        doc="todo"
+        doc="list of SpikeTrains contained in this group"
+    )
 
     segments = property(
         fget=lambda self: self._get_object_list("_segments"),

neo/core/segment.py

@@ -115,43 +115,43 @@ def __init__(self, name=None, description=None, file_origin=None,
     analogsignals = property(
         fget=lambda self: self._get_object_list("_analogsignals"),
         fset=lambda self, value: self._set_object_list("_analogsignals", value),
-        doc="todo"
+        doc="list of AnalogSignals contained in this segment"
     )
 
     irregularlysampledsignals = property(
         fget=lambda self: self._get_object_list("_irregularlysampledsignals"),
         fset=lambda self, value: self._set_object_list("_irregularlysampledsignals", value),
-        doc="todo"
+        doc="list of IrregularlySignals contained in this segment"
     )
 
     events = property(
         fget=lambda self: self._get_object_list("_events"),
         fset=lambda self, value: self._set_object_list("_events", value),
-        doc="todo"
+        doc="list of Events contained in this segment"
     )
 
     epochs = property(
         fget=lambda self: self._get_object_list("_epochs"),
         fset=lambda self, value: self._set_object_list("_epochs", value),
-        doc="todo"
+        doc="list of Epochs contained in this segment"
     )
 
     channelviews = property(
         fget=lambda self: self._get_object_list("_channelviews"),
         fset=lambda self, value: self._set_object_list("_channelviews", value),
-        doc="todo"
+        doc="list of ChannelViews contained in this segment"
     )
 
     imagesequences = property(
         fget=lambda self: self._get_object_list("_imagesequences"),
         fset=lambda self, value: self._set_object_list("_imagesequences", value),
-        doc="todo"
+        doc="list of ImageSequences contained in this segment"
     )
 
     spiketrains = property(
         fget=lambda self: self._get_object_list("_spiketrains"),
         fset=lambda self, value: self._set_object_list("_spiketrains", value),
-        doc="todo"
+        doc="list of SpikeTrains contained in this segment"
     )
 
     # t_start attribute is handled as a property so type checking can be done