Document noHdr.

c-blake · Jan 22, 2024 · a3a222e · a3a222e
1 parent 15f5d88
commit a3a222e
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/cligen.nim b/cligen.nim
@@ -350,6 +350,9 @@ macro dispatchGen*(pro: typed{nkSym}, cmdName: string="", doc: string="",
   ##``stopWords`` is a ``seq[string]`` of words beyond which ``-.*`` no longer
   ##signifies an option (like the common sole ``--`` command argument).
   ##
+  ##``noHdr`` is a (mostly internal) flag to suppress emitting "Usage:" header
+  ##in generated help tables (e.g. in a multi-command).
+  ##
   ##``mergeNames`` gives the ``cmdNames`` param passed to ``mergeParams``, which
   ##defaults to ``@[cmdName]`` if ``mergeNames`` is ``@[]``.
   ##