add help str to gcn-filename option

desy-multimessenger · Feb 10, 2025 · 86b1850 · 86b1850
1 parent c978add
commit 86b1850
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/nuztf/cli.py b/nuztf/cli.py
@@ -21,7 +21,14 @@ def main(
         str, typer.Argument(..., help="Name of the neutrino, e.g. `IC200530A`")
     ],
     logging_level: Annotated[str, typer.Option("--logging-level", "-l")] = "INFO",
-    gcn_filename: Annotated[str, typer.Option("--gcn-filename", "-f")] = None,
+    gcn_filename: Annotated[
+        str,
+        typer.Option(
+            "--gcn-filename",
+            "-f",
+            help="Filename to write GCN to, if None (default) print to console",
+        ),
+    ] = None,
 ):
 
     logger = logging.getLogger("nuztf")