docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Sebastiaan van Stijn 2020-03-16 13:09:27 +01:00
parent a76cbe68a7
commit 252db13907
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
_includes/cli.md
View File

@ -89,6 +89,13 @@ your client and daemon API versions.
```
{% endif %}
{% unless site.data[include.datafolder][include.datafile].long == site.data[include.datafolder][include.datafile].short %}
## Extended description
{{ site.data[include.datafolder][include.datafile].long }}
{% endunless %}
{% if site.data[include.datafolder][include.datafile].options %}
{% if site.data[include.datafolder][include.datafile].inherited_options %}
{% 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.
{% endif %} <!-- end if options -->
{% unless site.data[include.datafolder][include.datafile].long == site.data[include.datafolder][include.datafile].short %}
## Extended description
{{ site.data[include.datafolder][include.datafile].long }}
{% endunless %}
{% if site.data[include.datafolder][include.datafile].examples %}
## Examples