Issue #14072 has been updated by Randall Hansen.
I agree with what you say about "use;" it's not ideal. "Reference" is talking about what the code does, not about the user-facing effects. That's one important decision, I think: from whose perspective should we approach this? * `display_global_options`? * `inherit_options`? * `inherit_global_options`? I prefer the plural because it can remind people that it takes multiple values. There's less harm, I think, in people using a one-element array than in using the option multiple times. I'm willing to be wrong about that. ---------------------------------------- Feature #14072: Allow faces to pull in global settings documentation https://projects.puppetlabs.com/issues/14072#change-60972 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.
