Issue #7833 has been updated by Daniel Pittman.

>> catalog apply – “RETURNS” wraps at 85 characters.
>
> Oh! It looked fine in the source, but I didn’t account for the fact that
> we’re prepending “RETURNS: ” to the first line!

Perhaps it should be called out more as a header, than inline to the first line?

> The only other thing it looks like this could happen with are synopses and
> termini, which we don’t have any smart wrapping code for. I’m content to
> leave those problems for later, though. In the meantime, I searched for ^
> *returns .*$\r *([^ ].{70,}$) and found one more bad wrap in config print’s
> return info.

Using the same pretty printing library that we use for the synopsis
would absolutely be possible, but a bit less flexible, in building out
something that would correctly word-wrap.  A naive implementation
could use splitting in whitespace for the input, and then allowing
break between any word, but would want a bit of paragraph detection
smarts and prefix detection to work well...
----------------------------------------
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.

Reply via email to