Jira (PDOC-297) Add tag for marking class parameters as "advanced"

8 views
Skip to first unread message

Ben Ford (JIRA)

unread,
Feb 4, 2020, 9:46:04 AM2/4/20
to puppe...@googlegroups.com
Ben Ford created an issue
 
Puppet Strings / Bug PDOC-297
Add tag for marking class parameters as "advanced"
Issue Type: Bug Bug
Assignee: Unassigned
Created: 2020/02/04 6:45 AM
Priority: Normal Normal
Reporter: Ben Ford

It would be nice to be able to differentiate the parameters that are recommended to use and those that are advanced and should rarely be used. Or arbitrary named groups in the docs.

Add Comment Add Comment
 
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Atlassian logo

Ben Ford (JIRA)

unread,
Feb 4, 2020, 9:48:04 AM2/4/20
to puppe...@googlegroups.com

Jean Bond (JIRA)

unread,
Feb 4, 2020, 10:52:03 AM2/4/20
to puppe...@googlegroups.com
Jean Bond commented on Bug PDOC-297

Can we stay away from the word "advanced"? It doesn't carry a lot of useful meaning: How do I know if my use case is advanced? I am a smart person and/or I know a lot about Puppet, I think I should use this advanced feature. Or conversely, I do not feel like I am "advanced" at Puppet, so even if I do need this parameter, maybe I should leave it alone.

If it's for edge cases or special specific uses, or if it's dangerous and can make things go sideways, it should say that in the description. But advanced doesn't tell you very much.

Jesse Scott (JIRA)

unread,
Feb 4, 2020, 8:05:04 PM2/4/20
to puppe...@googlegroups.com
Jesse Scott commented on Bug PDOC-297

I agree with Jean Bond's point that this really seems better addressed with words in the parameter description. "advanced" is really subjective and not really useful on it's own.

Ewoud Kohl van Wijngaarden (Jira)

unread,
Jun 3, 2020, 2:10:03 PM6/3/20
to puppe...@googlegroups.com

Initially I opened https://tickets.puppetlabs.com/browse/PDOC-267 which is more generic. Advanced is just one possible group. Should this be closed as a duplicate?

This message was sent by Atlassian Jira (v8.5.2#805002-sha1:a66f935)
Atlassian logo
Reply all
Reply to author
Forward
0 new messages