Issue #5491 has been updated by Garrett Honeycutt. Status changed from Rejected to Re-opened Assignee changed from James Turnbull to Nigel Kersten
Thank you for explaining the current behavior. My question for Nigel would be, is this how things ought to be? Having two ways to show help is bad UI and I urge that we have only one command that invokes this functionality. My suggestion is that we pick one term (describe or doc) and use that. If you type 'puppet [describe/doc]' with no arguments you should get all the docs and typing 'puppet [describe/doc] [type]' would return only documentation about your queried type. Besides my own personal confusion, I have seen this come up multiple times during training. Thanks, -g ---------------------------------------- Bug #5491: doc vs describe https://projects.puppetlabs.com/issues/5491 Author: Garrett Honeycutt Status: Re-opened Priority: Normal Assignee: Nigel Kersten Category: Target version: Affected Puppet version: 2.6.4 Keywords: describe documention Branch: We currently have two ways to generate documentation. This is leading to confusion, especially since the interface for each is different. Why are there two commands to give me documentation? # puppet describe --help <pre> SYNOPSIS ======== Print help about puppet types on the console. Run with '-h' to get detailed help. </pre> # puppet doc --help <pre> SYNOPSIS ======== Generate a reference for all Puppet types. Largely meant for internal Puppet Labs use. </pre> Why do I have to know the difference? <pre> puppet describe [type] -s puppet doc -r type </pre> -- 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.
