Github user rmetzger commented on the pull request:

    https://github.com/apache/flink/pull/1097#issuecomment-157645907
  
    Thank you for reviewing the pull request while I was away @fhueske.
    
    I've just tried it out with this code:
    ```java
    RequiredParameters rp = new RequiredParameters();
    rp.add("input");
    rp.add("output");
    rp.add(new Option("parallelism").alt("p").help("Set the parallelism for all 
operators").type(OptionType.INTEGER));
    ParameterTool pt = ParameterTool.fromArgs(args);
    try {
        rp.applyTo(pt);
    } catch(RequiredParametersException rpe) {
        System.out.println(rp.getHelp());
        System.exit(1);
    }
    ```
    
    and the output is the following:
    ```
     Required Parameter
    name, short name, help text, default valueinput     null    
    output      null    
    parallelism p       Set the parallelism for all operators   
    ```
    
    I think the `getHelp` method is not producing helpful output here.
    
    How about something like:
    ```
    Required Parameters:
        --input
        --output
        -p, --parallelism        Set the parallelism for all operators
    ```
    
    The `RequiredParametersException` could list the missing arguments.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---

Reply via email to