Update build_datastructure_doc.py (#1202)

Added a dependency diagram explanation to reduce confusion.
XENONnT · Jun 19, 2023 · f728169 · f728169
1 parent e6a70f6
commit f728169
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/source/build_datastructure_doc.py b/docs/source/build_datastructure_doc.py
@@ -25,6 +25,8 @@
 This page is an autogenerated reference for all the plugins in straxen's
 `{context}` context. 
 
+The figures presented are dependency diagrams, meaning that an arrow stemming from a node points to a node that the stem depends on (i.e. "A depends on B" is equivalent to "A ---> B"). 
+
 Colors indicate data kinds. To load tables with different data kinds,
 you currently need more than one `get_df` (or `get_array`) commands.