Skip to content

Commit 9a34a87

Browse files
committed
fixed issues arising from reverting incompatible binary changes
1 parent 1cbac2f commit 9a34a87

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

src/main/java/org/apache/commons/cli/help/AbstractHelpFormatter.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ public void printHelp(final String cmdLineSyntax, final String header, final Opt
322322
* @param autoUsage whether to print an automatically generated usage statement.
323323
* @throws IOException If the output could not be written to the {@link HelpAppendable}.
324324
*/
325-
public final void printHelp(final String cmdLineSyntax, final String header, final Iterable<Option> options, final String footer, final boolean autoUsage)
325+
public void printHelp(final String cmdLineSyntax, final String header, final Iterable<Option> options, final String footer, final boolean autoUsage)
326326
throws IOException {
327327
Options optionsObject = new Options();
328328
options.forEach(optionsObject::addOption);
@@ -405,7 +405,11 @@ public final String toArgName(final String argName) {
405405

406406
/**
407407
* Return the string representation of the options as used in the syntax display.
408-
*
408+
* <p>
409+
* This is probably not the method you want. This method does not track the presence
410+
* of option groups. To display the option grouping use {@link #toSyntaxOptions(Options)} or
411+
* {@link #toSyntaxOptions(OptionGroup)} for individual groups.
412+
* </p>
409413
* @param options The collection of {@link Option} instances to create the string representation for.
410414
* @return the string representation of the options as used in the syntax display.
411415
*/

0 commit comments

Comments
 (0)