Skip to content

Commit

Permalink
[DOC-PR#1539] Revised documentation
Browse files Browse the repository at this point in the history
I've made changes to alleviate ambiguity around "commands" and "subcommands" in the context of aliases
  • Loading branch information
hamid-nazari authored and remkop committed Jan 3, 2022
1 parent 77a3d43 commit 2043891
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8060,7 +8060,7 @@ class ListFiles : Runnable {
----

=== Subcommand Aliases
Commands may optionally define an `aliases` attribute to provide alternate names for subcommands that will be recognized by the parser. Aliases are displayed in the default help output. For example:
Commands may optionally define an `aliases` attribute to provide alternate names that will be recognized by the parser. Aliases are displayed in the default help output. For example:

.Java
[source,java,role="primary"]
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12344,7 +12344,7 @@ <h3 id="parentcommand-annotation"><a class="anchor" href="#parentcommand-annotat
<div class="sect2">
<h3 id="_subcommand_aliases"><a class="anchor" href="#_subcommand_aliases"></a>17.8. Subcommand Aliases</h3>
<div class="paragraph">
<p>Commands may optionally define an <code>aliases</code> attribute to provide alternate names for subcommands that will be recognized by the parser. Aliases are displayed in the default help output. For example:</p>
<p>Commands may optionally define an <code>aliases</code> attribute to provide alternate names that will be recognized by the parser. Aliases are displayed in the default help output. For example:</p>
</div>
<div class="listingblock primary">
<div class="title">Java</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/man/3.x/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3815,7 +3815,7 @@ <h3 id="_registering_subcommands_declaratively">13.2. Registering Subcommands De
<div class="sect2">
<h3 id="_subcommand_aliases">13.3. Subcommand Aliases</h3>
<div class="paragraph">
<p>Commands may optionally define an <code>aliases</code> attribute to provide alternate names for subcommands that will be recognized by the parser. Aliases are displayed in the default help output. For example:</p>
<p>Commands may optionally define an <code>aliases</code> attribute to provide alternate names that will be recognized by the parser. Aliases are displayed in the default help output. For example:</p>
</div>
<div class="listingblock">
<div class="content">
Expand Down

0 comments on commit 2043891

Please sign in to comment.