[#1443] DOC: Fix incorrect method name setLongOptionsMaxWidth in us…

…er manual section 'Long Option Column Width' Closes #1443
remkop · Oct 19, 2021 · 3421ba6 · 3421ba6
1 parent 498d974
commit 3421ba6
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -52,6 +52,7 @@ Picocli follows [semantic versioning](http://semver.org/).
 * [#1336] DOC: Kotlin sample code, documentation improvements. Thanks to [Andreas Deininger](https://github.com/deining) for the pull request.
 * [#1342] DOC: Improve user manual chapter 28.3 'Testing the Exit Code'. Thanks to [Andreas Deininger](https://github.com/deining) for the pull request.
 * [#1344] DOC: Documentation, chapter 'Testing environment variables:': add Kotlin test sample. Thanks to [Andreas Deininger](https://github.com/deining) for the pull request.
+* [#1443] DOC: Fix incorrect method name `setLongOptionsMaxWidth` to `setUsageHelpLongOptionsMaxWidth` in user manual section 'Long Option Column Width'. Thanks to [kunlk](https://github.com/kunlk) for raising this.
 * [#1360][#1359] DOC: add JReleaser as packaging option. Thanks to [Andres Almiray](https://github.com/aalmiray) for the pull request.
 * [#1363][#1364] DOC: Add caution on Variable interpolation in Kotlin. Thanks to [MagnusMG](https://github.com/MagnusMG) for the pull request.
 * [#1397][#1399] DOC: Update Jline2 README.md to add some recommended workaround about ANSI incompatible terminals. Thanks to [Simon](https://github.com/sbernard31) for the pull request.

diff --git a/docs/index.adoc b/docs/index.adoc
@@ -5743,9 +5743,9 @@ Usage: myapp [-hV] [-o=<outputFolder>]
   -V, --version   Print version information and exit.
 ----
 
-As of picocli 4.2, there is programmatic API to change this via the `CommandLine::setLongOptionsMaxWidth` and `UsageMessageSpec::longOptionsMaxWidth` methods.
+As of picocli 4.2, there is programmatic API to change this via the `CommandLine::setUsageHelpLongOptionsMaxWidth` and `UsageMessageSpec::longOptionsMaxWidth` methods.
 
-In the above example, if we call `commandLine.setLongOptionsMaxWidth(23)` before printing the usage help, we get this result:
+In the above example, if we call `commandLine.setUsageHelpLongOptionsMaxWidth(23)` before printing the usage help, we get this result:
 
 ----
 Usage: myapp [-hV] [-o=<outputFolder>]

diff --git a/docs/index.html b/docs/index.html
@@ -10413,10 +10413,10 @@ <h3 id="_long_option_column_width"><a class="anchor" href="#_long_option_column_
 </div>
 </div>
 <div class="paragraph">
-<p>As of picocli 4.2, there is programmatic API to change this via the <code>CommandLine::setLongOptionsMaxWidth</code> and <code>UsageMessageSpec::longOptionsMaxWidth</code> methods.</p>
+<p>As of picocli 4.2, there is programmatic API to change this via the <code>CommandLine::setUsageHelpLongOptionsMaxWidth</code> and <code>UsageMessageSpec::longOptionsMaxWidth</code> methods.</p>
 </div>
 <div class="paragraph">
-<p>In the above example, if we call <code>commandLine.setLongOptionsMaxWidth(23)</code> before printing the usage help, we get this result:</p>
+<p>In the above example, if we call <code>commandLine.setUsageHelpLongOptionsMaxWidth(23)</code> before printing the usage help, we get this result:</p>
 </div>
 <div class="listingblock">
 <div class="content">