Issue #16571 has been updated by Gerrard Geldenhuis.

It would also be useful to simulate help behaviour similar to git help. 
Currently a long help page will just scroll over the screen and you will have 
to retype or Crtl+a to get the command and then pipe to less to actually read 
it. Git help seems to automatically pipe to git or at least implement similar 
behavior.

----------------------------------------
Bug #16571: puppet commands should respond correctly to --help
https://projects.puppetlabs.com/issues/16571#change-100973

* Author: R.I. Pienaar
* Status: Accepted
* Priority: Normal
* Assignee: eric sorenson
* Category: usability
* Target version: 3.x
* Affected Puppet version: 
* Keywords: errors, interaction, CLI
* Branch: 
----------------------------------------
<pre>
% puppet module --help
err: 'module' has no default action.  See `puppet help module`.
% puppet help module
USAGE: puppet module <action> 
</pre>

The --help option should just do the right thing as is customary in unix 
applications.

When working on the unix cli you want to move forward not backward:

  * type a command, up arrow, add an option, enter, up arrow, append the 
options you learned about.  

This has a natural forward moving rhythm to it that does not cause 
interruptions to your train of thought

This behavior wrt --help forces people to move backward an ever varying amount 
of steps which is an interruption to the natural flow of the unix CLI usage: 

  * type a command, up arrow, back arrow 7 times, type a command, up arrow, 
append the options you learned about

The attention you have to give to the back arrowing step is hugely disruptive, 
it's an entire different train of thought



-- 
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 unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/puppet-bugs.
For more options, visit https://groups.google.com/groups/opt_out.

Reply via email to