[groovy] branch master updated: GROOVY-9531: improve CliBuilder documentation to clarify what functionality is available in which version

[rp...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rpopma pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git


The following commit(s) were added to refs/heads/master by this push:
     new 152930d  GROOVY-9531: improve CliBuilder documentation to clarify what functionality is available in which version
152930d is described below

commit 152930dfe85221a536f2efc62dd0e7e0d5e65807
Author: Remko Popma <re...@yahoo.com>
AuthorDate: Wed Apr 29 12:09:25 2020 +0900

    GROOVY-9531: improve CliBuilder documentation to clarify what functionality is available in which version
---
 src/spec/doc/core-domain-specific-languages.adoc | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/src/spec/doc/core-domain-specific-languages.adoc b/src/spec/doc/core-domain-specific-languages.adoc
index f88b013..bf2371a 100644
--- a/src/spec/doc/core-domain-specific-languages.adoc
+++ b/src/spec/doc/core-domain-specific-languages.adoc
@@ -1114,10 +1114,9 @@ def options = cli.parse(args)                              <5>
 if (options.h) cli.usage()                                 <6>
 else println "Hello ${options.a ? options.a : 'World'}"    <7>
 ---------------------------
-<1> Earlier versions of Groovy had a CliBuilder in the groovy.util package and no import was necessary.
-While still supported, this approach is now deprecated and you should instead choose the groovy.cli.picocli
-or groovy.cli.commons version. The groovy.util version points to the commons-cli version for backwards compatibility
-but will be removed in a future version of Groovy.
+<1> Earlier versions of Groovy had a CliBuilder in the `groovy.util` package and no import was necessary.
+In Groovy 2.5, this approach became deprecated: applications should instead choose the `groovy.cli.picocli` or `groovy.cli.commons` version.
+The groovy.util version in Groovy 2.5 points to the commons-cli version for backwards compatibility but has been removed in Groovy 3.0.
 <2> define a new `CliBuilder` instance specifying an optional usage string
 <3> specify a `-a` option taking a single argument with an optional long variant `--audience`
 <4> specify a `-h` option taking no arguments with an optional long variant `--help`