Skip to content

Commit 285b03a

Browse files
committed
echo-help: fix --help text
1 parent 22454f9 commit 285b03a

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

commands/echo-help

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -179,18 +179,33 @@ function echo_help() (
179179
You can combine these like so \`--timeout=<timeout:max|immediate|<seconds>>\`
180180
Text wrapped in three backticks indicates literal code that ignores the above, e.g. \`\`\`--timeout=<timeout:max|immediate|<seconds>>\`\`\`
181181
A URL wrapped in angled brackets indicates a URL: \`\`\`<https://dorothy.bevry.me>\`\`\` becomes <https://dorothy.bevry.me>
182+
A line that is all capitals with a trailing colon indicates a header, such as the \`ABOUT:\`, \`USAGE:\`, \`OPTIONS:\`, and \`TEMPLATE:\` from earlier.
182183
183-
A line that is all capitals with a trailing colon indicates a header.
184-
EXAMPLE:
185-
186-
A line that starts with an asterisk \`*\` indicates a list item:
184+
A line that starts with an asterisk \`*\` indicates a list item, e.g.:
185+
\`\`\`
186+
* list item
187+
* nested list item
188+
\`\`\`
189+
becomes:
187190
* list item
188191
* nested list item
189192
190-
A line that starts with a an \`\`\`&\`\`\` indicates an action, and the \`\`\`&\`\`\` will be removed.
193+
A line that starts with a an \`\`\`&\`\`\` indicates an action, and the \`\`\`&\`\`\` will be removed, e.g.:
194+
\`\`\`
195+
& delete
196+
\`\`\`
197+
becomes:
191198
& delete
192199
193-
A line that starts looks like an option, e.g. starts with a dash, bracket, dot, pipe, or ampersand indicates an option:
200+
A line that starts looks like an option, e.g. starts with a dash, bracket, dot, pipe, or ampersand indicates an option, e.g.
201+
\`\`\`
202+
--option
203+
Some documentation.
204+
<value>
205+
* If \`thing\`, do that.
206+
* If \`other\`, do this.
207+
\`\`\`
208+
becomes:
194209
--option
195210
Some documentation.
196211
<value>

0 commit comments

Comments
 (0)