From 36f96a56a48d9c676314d147d38b3b74d888bc44 Mon Sep 17 00:00:00 2001
From: Agustin Borgna <agustin.borgna@quantinuum.com>
Date: Wed, 4 Oct 2023 10:11:08 +0100
Subject: [PATCH] ci flag doc

---
 src/utils.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/utils.rs b/src/utils.rs
index f0f8ccd2..22456624 100644
--- a/src/utils.rs
+++ b/src/utils.rs
@@ -42,6 +42,8 @@ pub(crate) mod test {
     /// Open a browser page to render a dot string graph.
     ///
     /// This can be used directly on the output of `Hugr::dot_string`
+    ///
+    /// Only for use in local testing. Will fail to compile on CI.
     #[cfg(not(ci_run))]
     pub(crate) fn viz_dotstr(dotstr: impl AsRef<str>) {
         let mut base: String = "https://dreampuf.github.io/GraphvizOnline/#".into();
@@ -50,6 +52,8 @@ pub(crate) mod test {
     }
 
     /// Open a browser page to render a HugrView's dot string graph.
+    ///
+    /// Only for use in local testing. Will fail to compile on CI.
     #[cfg(not(ci_run))]
     pub(crate) fn viz_hugr(hugr: &impl HugrView) {
         viz_dotstr(hugr.dot_string());