[
https://issues.apache.org/jira/browse/FELIX-3215?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13147634#comment-13147634
]
Glyn Normington commented on FELIX-3215:
----------------------------------------
Unfortunately, JIRA does not use a fixed pitch font for comments, so the
desired formatting is not shows in the description of the bug. Imagine that the
parameter names "operation" and "bundle id" were aligned so that they start in
the same column of the output.
> Gogo could align its parameter help better
> ------------------------------------------
>
> Key: FELIX-3215
> URL: https://issues.apache.org/jira/browse/FELIX-3215
> Project: Felix
> Issue Type: Improvement
> Reporter: Glyn Normington
> Priority: Trivial
>
> In implementing Virgo bug
> https://bugs.eclipse.org/bugs/show_bug.cgi?id=350853, I ran into this issue.
> The following is the desired output:
> osgi> help vsh:bundle
> bundle - examine or manage a bundle artifact
> scope: vsh
> parameters:
> String operation (examine|diag|headers|start|stop|refresh|uninstall)
> long bundle id
> ...
> Note that "operation" and "bundle id" are aligned even though "String" and
> "long" are not the same length. To achiever this, I had to code extra spaces
> in the descriptor for bundle id as follows:
> @Descriptor("examine or manage a bundle artifact")
> public void bundle(@Descriptor("operation
> (examine|diag|headers|start|stop|refresh|uninstall)") String op,
> @Descriptor(" bundle id") long bundleId) {
> doBundle(op, String.valueOf(bundleId));
> }
> It would be helpful if Gogo handled this alignment automatically. In
> particular, it would make the using code easier to maintain.
> Note that this bug has priority trivial, but would be a good one for a
> beginner to have a go at fixing.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
