Skip to content

Bring the docs landing page back in line with CLI.html #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hellerve merged 1 commit into from
Aug 22, 2026
Merged

Bring the docs landing page back in line with CLI.html #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ <h3 id="Completion">
<pre><code class="language-clojure">(IO.println &amp;(CLI.Completion.bash &amp;p &quot;mytool&quot;))
(IO.println &amp;(CLI.Completion.App.zsh &amp;app &quot;mytool&quot;))
</code></pre>
<p><code>bash</code> and <code>zsh</code> are supported, for a <code>Parser</code> and — under
<p><code>bash</code>, <code>zsh</code> and <code>fish</code> are supported, for a <code>Parser</code> and — under
<a href="#completionapp"><code>Completion.App</code></a> — for an <code>App</code>. Descriptions, flag names and
declared value sets are quoted and escaped for the target shell, so a
description containing quotes, backslashes or dollar signs cannot break (or
Expand Down Expand Up @@ -429,8 +429,11 @@ <h3 id="parse">
Non-flag tokens fill positional arguments in the order they were added, and
flags and positionals can be interleaved freely. A bare <code>--</code> ends option
parsing — every following token becomes a positional even if it starts with <code>-</code>
— and a token shaped like a negative number (<code>-5</code>, <code>-3.14</code>) is a positional, not
an unknown option.</p>
— and a token shaped like a negative number (<code>-5</code>, <code>-3.14</code>), or a lone <code>-</code>
(conventionally standard input), is a positional, not an unknown option.</p>
<p>An option can carry its value in the same token, as <code>--name=value</code> or
<code>-n=value</code>; only the first <code>=</code> separates them, so <code>--define=x=1</code> sets <code>define</code>
to <code>x=1</code>.</p>
<p>A single-dash token that matches no option exactly is decomposed into
single-character short options, so <code>-av</code> is <code>-a -v</code>. Booleans continue the
bundle; the first option that takes a value ends it and reads the rest of the
Expand Down