From e2c409075aedbaa46e4a4fba4e71e59368725b38 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Al=C3=A1n=20Mu=C3=B1oz?= <alan.munoz@ed.ac.uk>
Date: Wed, 28 Sep 2022 00:45:49 +0100
Subject: [PATCH] docs(cells): Improve function docs
---
src/agora/io/cells.py | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/src/agora/io/cells.py b/src/agora/io/cells.py
index a8ca61b0..095b59c4 100644
--- a/src/agora/io/cells.py
+++ b/src/agora/io/cells.py
@@ -160,8 +160,11 @@ class Cells:
def group_by_traps(
self, traps: t.Collection, cell_labels: t.Collection
) -> t.Dict[int, t.List[int]]:
- # returns a dict with traps as keys and list of labels as value
- # Data is a
+ """
+ Returns a dict with traps as keys and list of labels as value.
+ Note that the total number of traps are calculated from Cells.traps.
+
+ """
iterator = groupby(zip(traps, cell_labels), lambda x: x[0])
d = {key: [x[1] for x in group] for key, group in iterator}
d = {i: d.get(i, []) for i in self.traps}
--
GitLab