From 191cbbd7e66c6007f6e0e6989d1f6beb24e76ded Mon Sep 17 00:00:00 2001 From: Erfan Nourbakhsh Date: Mon, 13 Jan 2025 01:47:54 -0500 Subject: [PATCH 1/2] Clarify purpose of mermaid tools in docs --- python/lsst/pipe/base/mermaid_tools.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/python/lsst/pipe/base/mermaid_tools.py b/python/lsst/pipe/base/mermaid_tools.py index 3563d6a94..1f064c5b5 100644 --- 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] From de77370d914a3536b5bfe0bbec54cebd34200e6e Mon Sep 17 00:00:00 2001 From: Erfan Nourbakhsh Date: Mon, 13 Jan 2025 01:48:12 -0500 Subject: [PATCH 2/2] Add a release note for mermaid support --- doc/changes/DM-46503.feature.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changes/DM-46503.feature.rst diff --git a/doc/changes/DM-46503.feature.rst b/doc/changes/DM-46503.feature.rst new file mode 100644 index 000000000..8030ed7d1 --- /dev/null +++ b/doc/changes/DM-46503.feature.rst @@ -0,0 +1 @@ +Added Mermaid for pipeline and quantum graph visualization with tools for documentation/presentation purposes. \ No newline at end of file