From 252db1390726548bf2029747de616ed9e030f7ef Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 16 Mar 2020 13:09:27 +0100 Subject: [PATCH] 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 --- _includes/cli.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/_includes/cli.md b/_includes/cli.md index 937a7d5df1..655e04eaed 100644 --- a/_includes/cli.md +++ b/_includes/cli.md @@ -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 %} -{% 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