Merge pull request #462 from lsst/tickets/DM-48395

DM-48395: Document newly added support for Mermaid graphs
lsst · Feb 5, 2025 · e6d3d59 · e6d3d59
2 parents 704effe + de77370
commit e6d3d59
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/doc/changes/DM-46503.feature.rst b/doc/changes/DM-46503.feature.rst
@@ -0,0 +1 @@
+Added Mermaid for pipeline and quantum graph visualization with tools for documentation/presentation purposes.
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]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Added Mermaid for pipeline and quantum graph visualization with tools for documentation/presentation purposes.