Clarify purpose of mermaid tools in docs

lsst · Jan 13, 2025 · 8aa2744 · 8aa2744
1 parent 4e4daad
commit 8aa2744
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/python/lsst/pipe/base/mermaid_tools.py b/python/lsst/pipe/base/mermaid_tools.py
@@ -80,6 +80,8 @@ def _makeDatasetNode(dsRef: DatasetRef, allDatasetRefs: dict[str, str], file: An
 def graph2mermaid(qgraph: QuantumGraph, file: Any) -> None:
     """Convert QuantumGraph into a Mermaid flowchart (top-down).
 
+    This method is mostly for documentation/presentation purposes.
+
     Parameters
     ----------
     qgraph : `~lsst.pipe.base.QuantumGraph`
@@ -301,6 +303,8 @@ def pipeline2mermaid(
     This function produces a Mermaid flowchart, representing tasks and their
     inputs/outputs as dataset nodes. It uses a top-down layout.
 
+    This method is mostly for documentation/presentation purposes.
+
     Parameters
     ----------
     pipeline : Pipeline or Iterable[TaskDef]