Fix docstrings: Nodes.get, Edges.get (#239)

BlueBrain · Oct 19, 2023 · 6315a6b · 6315a6b
1 parent 4091868
commit 6315a6b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/bluepysnap/edges/edges.py b/bluepysnap/edges/edges.py
@@ -83,17 +83,16 @@ def ids(self, group=None, sample=None, limit=None):
         return self._get_ids_from_pop(fun, CircuitEdgeIds, sample=sample, limit=limit)
 
     def get(self, edge_ids=None, properties=None):  # pylint: disable=arguments-renamed
-        """Edge properties as pandas DataFrame.
+        """Edge properties by iterating populations.
 
         Args:
             edge_ids (int/CircuitEdgeId/CircuitEdgeIds/sequence): same as Edges.ids().
             properties (None/str/list): an edge property name or a list of edge property names.
                 If set to None ids are returned.
 
         Returns:
-            pandas.Series/pandas.DataFrame:
-                - A pandas Series indexed by edge IDs if ``properties`` is scalar.
-                - A pandas DataFrame indexed by edge IDs if ``properties`` is list.
+            generator: yields tuples of ``(<population_name>, pandas.DataFrame)``:
+                - DataFrame indexed by CircuitEdgeIds containing the properties from ``properties``.
 
         Notes:
             The Edges.property_names function will give you all the usable properties

diff --git a/bluepysnap/nodes/nodes.py b/bluepysnap/nodes/nodes.py
@@ -121,7 +121,7 @@ def ids(self, group=None, sample=None, limit=None):
         return self._get_ids_from_pop(fun, CircuitNodeIds, sample=sample, limit=limit)
 
     def get(self, group=None, properties=None):  # pylint: disable=arguments-differ
-        """Node properties as a pandas DataFrame.
+        """Node properties by iterating populations.
 
         Args:
             group (CircuitNodeIds/int/sequence/str/mapping/None): Which nodes will have their
@@ -132,8 +132,8 @@ def get(self, group=None, properties=None):  # pylint: disable=arguments-differ
                 Otherwise return all properties.
 
         Returns:
-            pandas.DataFrame: Return a pandas DataFrame indexed by NodeCircuitIds containing the
-                properties from ``properties``.
+            generator: yields tuples of ``(<population_name>, pandas.DataFrame)``:
+                - DataFrame indexed by CircuitNodeIds containing the properties from ``properties``.
 
         Notes:
             The NodePopulation.property_names function will give you all the usable properties