Issue #7833 has been updated by Nick Fagerlund.
> would be nice if \[`--ca-location`\] didn’t wrap
Some option summaries are going to wrap, which is why we wrote the template
code to do so. The number that do that could be reduced by crowding the space
allowed for the option invocation, but I opted not to do that because I
considered wrapping the invocation to be a harder failure mode than wrapping
the summary.
We've got 45 chars before wrap, and the balance I'm working with is badness of
wrapping vs. syntactical badness vs. incomplete information. I consider
syntactical badness and incompleteness to both be worse than wrapping, pretty
much across the board. Before we go much further on that, do you agree? Do you
think we're allowing too much space for the invocations? (Or that a single dash
is sufficient, no need for space-dash-space?)
That said, here are some alternatives for that option summary:
--------------------------------------------- (45-char ruler)
The CA to query (local or remote)
Which CA to use (local or remote)
Which cert authority to use (local or remote)
Any others?
----------------------------------------
Bug #7833: Further small issues with Faces CLI help
https://projects.puppetlabs.com/issues/7833
Author: Randall Hansen
Status: Accepted
Priority: Normal
Assignee: Nick Fagerlund
Category:
Target version: 2.7.0
Affected Puppet version:
Keywords:
Branch:
<pre>
puppet help catalog apply
</pre>
* "RETURNS" wraps at 85 characters. I thought our wrap limit was lower?
<pre>
puppet help certificate *
--ca-location LOCATION - The certificate authority to query (local
or
remote).
</pre>
* would be nice if this didn't wrap
<pre>
puppet help certificate destroy
puppet help certificate generate
puppet help certificate search
</pre>
* USAGE is broken over multiple lines
<pre>
puppet help certificate save
puppet help certificate_revocation_list save
puppet help node save
puppet help resource_type save
puppet help status save
</pre>
* `puppet help certificate` says "Invalid for this subcommand" but the help
says "API only."
* summary should lead with "API only"
<pre>
puppet help certificate_request search
</pre>
* what's <dummy_key> and why is it necessary?
<pre>
puppet help facts find
</pre>
* "RENDERING ISSUES: Facts cannot currently be rendered as a string."
* how are they rendered? binary? we should clarify this.
<pre>
puppet help facts upload
</pre>
* I'm not sure how you include TERMINI: is it only per subcommand, not per
action? Can we make this clearer?
--
You have received this notification because you have either subscribed to it,
or are involved in it.
To change your notification preferences, please click here:
http://projects.puppetlabs.com/my/account
--
You received this message because you are subscribed to the Google Groups
"Puppet Bugs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/puppet-bugs?hl=en.
