[
https://issues.apache.org/jira/browse/CLI-116?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Brian Egge updated CLI-116:
---------------------------
Description:
Just to suggest to allow the user to control the with of the first column of
the generated output from HelperFormatter.print() method, for the option
description.
Now this with is delimited by the longest option and some times it is not the
best solution, because the width of the second column (description) in order to
fix the maximum length (default 80) has to be short.
My suggestion is to give the possibility to the user to wrap the option
definition (first column), in case it is going to be longer to a given value.
This is useful for group options, for example something like this:
-report (-r)
-date|-list|-template|-param-names|-param-values|-format
-date (-d) date
-list (-l)
-template (-t) template [template ...]
-param-names (-pNames) name [name ...]
-param-values (-pValues) value [value ...]
-format (-f) format [format ...]
so the description field will be started after the longest option definition,
at column position after:
-date|-list|-template|-param-names|-param-values|-format
a better solution would be nevertheless to wrap also this line to a given
length, for example:
-report (-r)
-date|-list|-template|-param-names
|-param-values|-format
-date (-d) date
-list (-l)
-template (-t) template [template ...]
-param-names (-pNames) name [name ...]
-param-values (-pValues) value [value ...]
-format (-f) format [format ...]
it is easy to see the line is wrapped because the indentation level, so now the
second column, that is the description, will come after the -param-names option
definition which is now the longest option definition.
Thanks in advance,
David Leal
was:
Just to suggest to allow the user to controll the with of the first column of
the generated output from HelperFormatter.print() method, for the option
description.
Now this with is delimited by the longest option and some times it is not the
best solution, because the with of the second column (description) in order to
fix the maximum length (default 80) has to be short.
My suggestion is to give the possibility to the user to wrap the option
definition (first column), in case it is going to be longer to a given value.
This is usefull for group options, for example something like this:
-report (-r)
-date|-list|-template|-param-names|-param-values|-format
-date (-d) date
-list (-l)
-template (-t) template [template ...]
-param-names (-pNames) name [name ...]
-param-values (-pValues) value [value ...]
-format (-f) format [format ...]
so the description field will be started after the longest option definition,
at column possition after:
-date|-list|-template|-param-names|-param-values|-format
a better solution would be nevertheless to wrap also this line to a given
length, for example:
-report (-r)
-date|-list|-template|-param-names
|-param-values|-format
-date (-d) date
-list (-l)
-template (-t) template [template ...]
-param-names (-pNames) name [name ...]
-param-values (-pValues) value [value ...]
-format (-f) format [format ...]
it is easy to see the line is wrapped because the indentation level, so now the
second column, that is the description, will come after the -param-names option
definition which is now the longest option definition.
Thanks in advance,
David Leal
Summary: Allow to configure the width of the first column on the
HelperFormatter.print() method (was: Allow to configure the with of the first
column on the HelperFormatter.print() method)
> Allow to configure the width of the first column on the
> HelperFormatter.print() method
> --------------------------------------------------------------------------------------
>
> Key: CLI-116
> URL: https://issues.apache.org/jira/browse/CLI-116
> Project: Commons CLI
> Issue Type: Improvement
> Components: CLI-2.x
> Affects Versions: Nightly Builds
> Reporter: David Leal
> Fix For: 2.1
>
>
> Just to suggest to allow the user to control the with of the first column of
> the generated output from HelperFormatter.print() method, for the option
> description.
> Now this with is delimited by the longest option and some times it is not the
> best solution, because the width of the second column (description) in order
> to fix the maximum length (default 80) has to be short.
> My suggestion is to give the possibility to the user to wrap the option
> definition (first column), in case it is going to be longer to a given value.
> This is useful for group options, for example something like this:
> -report (-r)
> -date|-list|-template|-param-names|-param-values|-format
> -date (-d) date
> -list (-l)
> -template (-t) template [template ...]
> -param-names (-pNames) name [name ...]
> -param-values (-pValues) value [value ...]
> -format (-f) format [format ...]
> so the description field will be started after the longest option definition,
> at column position after:
> -date|-list|-template|-param-names|-param-values|-format
> a better solution would be nevertheless to wrap also this line to a given
> length, for example:
> -report (-r)
> -date|-list|-template|-param-names
> |-param-values|-format
> -date (-d) date
> -list (-l)
> -template (-t) template [template ...]
> -param-names (-pNames) name [name ...]
> -param-values (-pValues) value [value ...]
> -format (-f) format [format ...]
> it is easy to see the line is wrapped because the indentation level, so now
> the second column, that is the description, will come after the -param-names
> option definition which is now the longest option definition.
> Thanks in advance,
> David Leal
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
