From 90447e5f1e175f3f5c1fd9b4cea04d6616af104f Mon Sep 17 00:00:00 2001 From: Joni Herttuainen Date: Thu, 19 Oct 2023 11:15:28 +0200 Subject: [PATCH] further fix docstrings: return value on Edges.get, typo on Nodes.get --- bluepysnap/edges/edges.py | 5 ++--- bluepysnap/nodes/nodes.py | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/bluepysnap/edges/edges.py b/bluepysnap/edges/edges.py index 0313e4d4..17c0d243 100644 --- 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 ``(, 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 ``(, 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 index 5883cb30..f97e00be 100644 --- 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 ``(, 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