Issue #6962 has been updated by Daniel Pittman. Assignee changed from Daniel Pittman to Nick Fagerlund Target version changed from 2.6.8 to Statler Affected Puppet version set to development
The required changes are in `next`, and the work of finishing layout and inline documentation handed over. ---------------------------------------- Feature #6962: self-documenting strings, actions, and options https://projects.puppetlabs.com/issues/6962 Author: Daniel Pittman Status: Accepted Priority: Normal Assignee: Nick Fagerlund Category: strings Target version: Statler Affected Puppet version: development Keywords: Branch: We want to have strings, actions, and options as self-documenting as possible. This requires: * We can declare the documentation inline when creating the various objects in the system. * We can introspect the various bits and extract that documentation. * We expose this through a 'help' string that returns the structured data to allow generic renderings of that information. (eg: to a string for user presentation, or HTML, or whatever else we want based on the outside interface.) * We need to implement generic CLI interface that uses the help string to render the help to a string and present that to the user. * We need to implement a global option `--help` for all CLI strings that redirects from the requested string to the help string, and presents help to the user for the string they requested. -- 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.
