further fix docstrings: return value on Edges.get, typo on Nodes.get

BlueBrain · Oct 19, 2023 · 90447e5 · 90447e5
1 parent 7bc54c8
commit 90447e5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/bluepysnap/edges/edges.py b/bluepysnap/edges/edges.py
@@ -90,9 +90,8 @@ def get(self, edge_ids=None, properties=None):  # pylint: disable=arguments-rena
                 If set to None ids are returned.
 
         Returns:
-            generator: yields tuples of ``(<population_name>, pandas.DataFrame|pandas.Series)``:
-                - Series indexed by edge IDs if ``properties`` is scalar.
-                - 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
@@ -133,7 +133,7 @@ def get(self, group=None, properties=None):  # pylint: disable=arguments-differ
 
         Returns:
             generator: yields tuples of ``(<population_name>, pandas.DataFrame)``:
-                - DataFrame indexed by NodeCircuitIds containing the properties from ``properties``.
+                - DataFrame indexed by CircuitNodeIds containing the properties from ``properties``.
 
         Notes:
             The NodePopulation.property_names function will give you all the usable properties