diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 5e178e84..bf75d7a7 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,12 +1,12 @@ Changelog ========= -Version v2.2.0~dev0 +Version v3.0.0 -------------- Breaking Changes ~~~~~~~~~~~~~~~~ -- Edge populations' ``iter_connections`` returns ``CircuitNodeId``s instead of ``int``s +- Edge populations' ``iter_connections`` returns ``CircuitNodeId`` instead of ``int`` Version v2.1.0 diff --git a/bluepysnap/edges/edge_population.py b/bluepysnap/edges/edge_population.py index d5f5ff8b..c32cce72 100644 --- a/bluepysnap/edges/edge_population.py +++ b/bluepysnap/edges/edge_population.py @@ -519,7 +519,7 @@ def _optimal_direction(): break def _add_circuit_ids(self, its): - """Generator comprehension adding the CircuitIds to the iterator.""" + """Generator comprehension completing the CircuitNodeId.""" return ( ( CircuitNodeId(self.source.name, source_id), @@ -530,7 +530,8 @@ def _add_circuit_ids(self, its): ) def _add_edge_ids(self, its): - """Generator comprehension adding the CircuitIds to the iterator.""" + """Generator comprehension completing the CircuitNodeId + and adding the CircuitEdgeIds to the iterator.""" return ( ( CircuitNodeId(self.source.name, source_id), @@ -541,7 +542,8 @@ def _add_edge_ids(self, its): ) def _omit_edge_count(self, its): - """Generator comprehension adding the CircuitIds to the iterator.""" + """Generator comprehension completing the CircuitNodeId + and removing the edge count.""" return ( ( CircuitNodeId(self.source.name, source_id),