Changes as per review

Author: Claudenw

src/main/java/org/apache/commons/cli/HelpFormatter.java

@@ -130,12 +130,14 @@ public Builder setShowDeprecated(final boolean useDefaultFormat) {
     }
 
     /**
-     * Returns the option description or an empty string if the description is {@code null}.
+     * Gets the option description or an empty string if the description is {@code null}.
      * @param option The option to get the description from.
      * @return the option description or an empty string if the description is {@code null}.
+     * @since 2.17.0
      */
     public static String getDescription(final Option option) {
-        return option.getDescription() == null ? "" : option.getDescription();
+        String desc = option.getDescription();
+        return desc == null ? "" : desc;
     }
     /**
      * This class implements the {@code Comparator} interface for comparing Options.
@@ -274,7 +276,7 @@ private static PrintWriter createDefaultPrintWriter() {
     protected Comparator<Option> optionComparator = new OptionComparator();
 
     /**
-     * BiFunction to format the description for a deprecated option.
+     * Function to format the description for a deprecated option.
      */
     private final Function<Option, String> deprecatedFormatFunc;
 

src/site/xdoc/usage.xml

@@ -404,15 +404,14 @@ public static void main(String[] args) {
     try {
         // parse the command line arguments
         CommandLine line = parser.parse(options, args);
-    }
-    catch (ParseException exp) {
+    } catch (ParseException exp) {
         // oops, something went wrong
         System.err.println("Parsing failed.  Reason: " + exp.getMessage());
     }
 
     try {
         Integer value = line.getParsedOptionValue(count);
-        System.out.format("The value is %s\m", value );
+        System.out.format("The value is %s%n", value );
     } catch (ParseException e) {
         e.printStackTrace();
     }
@@ -449,7 +448,7 @@ public static void main(String[] args) {
   Option fooOpt = Option.builder("foo")
           .hasArg()
           .desc("the foo arg")
-          .converter((s) -> new Foo(s))
+          .converter(Foo::new)
           .build();</source>
             The above will create an option that passes the string value to the Foo constructor when <code>commandLine.getParsedOptionValue(fooOpt)</code> is called.
         </p>
@@ -509,10 +508,10 @@ public static void main(String[] args) {
       try {
           // parse the command line arguments
           line = parser.parse(options, new String[] {"-n", "5"});
-          System.out.println( "n="+line.getParsedOptionValue("n"));
+          System.out.println("n=" + line.getParsedOptionValue("n"));
       } catch (ParseException exp) {
           // oops, something went wrong
-          System.err.println("Parsing failed.  Reason: " + exp.getMessage());
+          System.err.println("Parsing failed. Reason: " + exp.getMessage());
       }
   }           </source>
               <p>
@@ -544,10 +543,10 @@ public static void main(String[] args) {
       try {
           // parse the command line arguments
           line = parser.parse(options, new String[] {"-n", "5"});
-          System.out.println( "n="+line.getParsedOptionValue("n"));
+          System.out.println("n=" + line.getParsedOptionValue("n"));
       } catch (ParseException exp) {
         // oops, something went wrong
-        System.err.println("Parsing failed.  Reason: " + exp.getMessage());
+        System.err.println("Parsing failed. Reason: " + exp.getMessage());
       }
   }           </source>
               <p>
@@ -589,7 +588,7 @@ public static void main(String[] args) {
               As an example of the second case above, changing the implementation of <code>doSomething</code> to
               <source>
   void doSomething(Options options) {
-      Function&lt;Option, String> disp = option -> String.format( "%s. %s", HelpFormatter.getDescription(option),
+      Function&lt;Option, String> disp = option -> String.format("%s. %s", HelpFormatter.getDescription(option),
                   option.getDeprecated().toString());
       HelpFormatter formatter = HelpFormatter.builder().setShowDeprecated(disp).get();
       formatter.printHelp("Command line syntax:", options);