diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index ccc83afc7..962f34004 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -7,7 +7,7 @@ This release offers a programmatic API for creating command line applications, a Another new feature in this release are Mixins. Mixins allow reusing common options, parameters and command attributes in multiple applications without copy-and-paste duplication. -Third, this release aims to reduce boilerplate code in user applications even further with the new `mixinStandardHelpOptions` command attribute. Picocli adds standard `usageHelp` and `versionHelp` options to commands with this attribute. Additionally picocli now offers a `HelpCommand` command that is a useful subcommand for user applications. +Third, this release aims to reduce boilerplate code in user applications even further with the new `mixinStandardHelpOptions` command attribute. Picocli adds standard `usageHelp` and `versionHelp` options to commands with this attribute. Additionally picocli now offers a `HelpCommand` that can be installed as a subcommand on any application command to provide usage help for the parent command or sibling subcommands. Additionally, fields annotated with `@Unmatched` will be populated with the unmatched arguments. @@ -45,7 +45,7 @@ public class ReusableOptions { } ``` -#### Programmatic Mixins +#### Adding Mixins Programmatically The below example shows how a mixin can be added programmatically with the `CommandLine.addMixin` method. ```java @@ -67,7 +67,7 @@ public class MyCommand { ``` -### Help Options +### Standard Help Options This release introduces the `mixinStandardHelpOptions` command attribute. When this attribute is set to `true`, picocli adds a mixin to the command that adds `usageHelp` and `versionHelp` options to the command. For example: ```java @@ -81,7 +81,7 @@ class AutoHelpDemo implements Runnable { } ``` -Commands with `mixinStandardHelpOptions` do not need to explicitly declare `usageHelp` or `versionHelp` options any more. The usage help message for the above example looks like this: +Commands with `mixinStandardHelpOptions` do not need to explicitly declare fields annotated with `@Option(usageHelp = true)` and `@Option(versionHelp = true)` any more. The usage help message for the above example looks like this: ```text Usage:
[-hV] [--option=