Issue #14072 has been updated by Jeff Weiss.
I believe the intent of people who attempt to define an option that has the same name as a global setting are trying to *remind* people that the global option exists **because** it can affect the face. I'll certainly defer to you on the UX of the DSL and how it should be named. I have an ever so slight reservation with 'use', because it someone could infer that there's magic going on, programmatically, in the background when they `use_global_option`, when it really only shows up on the help and man pages. If we want some programmatic magic to go on in the background, let's talk about it and make it happen. 'Use' vs. 'reference' is not something I have strong opinions about though. Regarding accepting an array, the work I have so far accepts either a single option or an array of options, although it isn't yet pluralized. ---------------------------------------- Feature #14072: Allow faces to pull in global settings documentation https://projects.puppetlabs.com/issues/14072#change-60958 Author: Jeff Weiss Status: Accepted Priority: Normal Assignee: Jeff Weiss Category: Target version: Affected Puppet version: Keywords: Branch: As a result of #13898, we can no longer specify an option in a face that collides with the name of a global setting. We do, however, have a need to pull in documentation to the face that says, "Hey, this global setting will really affect the operation of this face and here's it's documentation". For example `--modulepath` for the module face. What would be great would be to allow a face developer to be able to do something like this: <code> <pre> Puppet::Face.define(:module, '1.0.0') do action(:install) do refoption "modulepath" refoption "environment" ... </pre> </code> and the auto-generated documentation will pull in the documentation for `Puppet[:modulepath]` and `Puppet[:environment]` for `module install`. -- 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.
