expand schema docstring internally (#4926)

cylc · Jun 23, 2022 · 2c1ecf8 · 2c1ecf8
1 parent 60bf209
commit 2c1ecf8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 9 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -46,6 +46,9 @@ in `global.cylc[install]source dirs`.
 
 ### Fixes
 
+[#4926](https://github.com/cylc/cylc-flow/pull/4926) - Fix a docstring
+formatting problem presenting in the UI mutation flow argument info.
+
 [#4891](https://github.com/cylc/cylc-flow/pull/4891) - Fix bug that could cause
 past jobs to be omitted in the UI.
 

diff --git a/cylc/flow/network/schema.py b/cylc/flow/network/schema.py
@@ -1391,15 +1391,9 @@ def description(self):
 
 
 class Flow(String):
-    """An integer or one of {FLOW_ALL}, {FLOW_NEW} or {FLOW_NONE}."""
-
-
-# NOTE: docstrings can't be f-strings so we must manually format it.
-Flow.__doc__ = Flow.__doc__.format(  # type: ignore[union-attr]
-    FLOW_ALL=FLOW_ALL,
-    FLOW_NEW=FLOW_NEW,
-    FLOW_NONE=FLOW_NONE,
-)
+    __doc__ = (
+        f"""An integer or one of {FLOW_ALL}, {FLOW_NEW} or {FLOW_NONE}."""
+    )
 
 
 # Mutations: