Update docs

- Document option label
- Relates #433
This commit is contained in:
Janne Valkealahti
2022-06-14 21:25:01 +01:00
parent 088c4267b5
commit a019934169
3 changed files with 50 additions and 0 deletions

View File

@@ -0,0 +1,37 @@
[[using-shell-options-label]]
==== Label
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
_Option Label_ has no functional behaviour within a shell itself other than
what a default `help` command outputs. Within a command documentation
a type of an option is documented but this is not always super useful. Thus
you may want to give better descriptive word for an option.
====
[source, java, indent=0]
----
include::{snippets}/OptionSnippets.java[tag=option-registration-label]
----
====
Defining label is then shown in `help`.
====
[source, bash]
----
my-shell:>help mycommand
NAME
mycommand -
SYNOPSIS
mycommand --arg1 String --arg2 MYLABEL
OPTIONS
--arg1 String
[Optional]
--arg2 MYLABEL
[Optional]
----
====

View File

@@ -18,3 +18,5 @@ include::using-shell-options-optional.adoc[]
include::using-shell-options-default.adoc[]
include::using-shell-options-validation.adoc[]
include::using-shell-options-label.adoc[]

View File

@@ -163,6 +163,17 @@ public class OptionSnippets {
.build();
// end::option-registration-default[]
// tag::option-registration-label[]
CommandRegistration.builder()
.withOption()
.longNames("arg1")
.and()
.withOption()
.longNames("arg2")
.label("MYLABEL")
.and()
.build();
// end::option-registration-label[]
}
}