Add gap node note

CBroz1 · Jan 31, 2024 · abeb279 · abeb279
1 parent 51137c0
commit abeb279
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/spyglass/utils/dj_chains.py b/src/spyglass/utils/dj_chains.py
@@ -190,7 +190,9 @@ def pk_link(self, src, trg, data) -> float:
     def names(self) -> List[str]:
         """Return list of full table names in chain.
 
-        Uses networkx.shortest_path.
+        Uses networkx.shortest_path. Ignores numeric table names, which are
+        'gaps' or alias nodes in the graph. See datajoint.Diagram._make_graph
+        source code for comments on alias nodes.
         """
         if not self._has_link:
             return None