Skip to content

Commit 252db13

Browse files
thaJeztahthaJeztah
committed
Reference: move "extended description" above "options"
The extended description usually provides a good introduction to the command, which likely is useful to read before heading to more detailed information (such as "which options does this command have") Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
1 parent a76cbe6 commit 252db13

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

‎_includes/cli.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,13 @@ your client and daemon API versions.
8989
```
9090

9191
{% endif %}
92+
{% unless site.data[include.datafolder][include.datafile].long == site.data[include.datafolder][include.datafile].short %}
93+
94+
## Extended description
95+
96+
{{ site.data[include.datafolder][include.datafile].long }}
97+
98+
{% endunless %}
9299
{% if site.data[include.datafolder][include.datafile].options %}
93100
{% if site.data[include.datafolder][include.datafile].inherited_options %}
94101
{% assign alloptions = site.data[include.datafolder][include.datafile].options | concat:site.data[include.datafolder][include.datafile].inherited_options %}
@@ -130,14 +137,6 @@ your client and daemon API versions.
130137

131138
{% endif %} <!-- end if options -->
132139

133-
{% unless site.data[include.datafolder][include.datafile].long == site.data[include.datafolder][include.datafile].short %}
134-
135-
## Extended description
136-
137-
{{ site.data[include.datafolder][include.datafile].long }}
138-
139-
{% endunless %}
140-
141140
{% if site.data[include.datafolder][include.datafile].examples %}
142141

143142
## Examples

0 commit comments

Comments
 (0)