Jira (PDOC-123) Support groups of parameters
Title: Message Title Jesse Scott updated an issue Puppet Strings / PDOC-123 Support groups of parameters Change By: Jesse Scott Team: Puppet Developer Experience Add Comment This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-123) Support groups of parameters
Title: Message Title Eric Putnam commented on PDOC-123 Re: Support groups of parameters This has been requested by other community members as well. Something to keep in mind. Add Comment This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-123) Support groups of parameters
Title: Message Title Dominic Cleal commented on PDOC-123 Re: Support groups of parameters The syntax I suggested here isn't correct: @!group Database connection @param db_adapter Database adapter name @param db_host Database server hostname @param db_username Username to authenticate with @!endgroup The directive will group classes, defines and other handled objects, but not group tags such as @param on a single object - at least, not with the group directive supplied by YARD as far as I can tell. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe)
Jira (PDOC-123) Support groups of parameters
Title: Message Title Henrik Lindberg commented on PDOC-123 Re: Support groups of parameters Yes, but nesting "param" under "group" would be a breaking change. Adding a list of groups with each param listed by name would not break API, nor would adding "group" to the param itself. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-123) Support groups of parameters
Title: Message Title Dominic Cleal commented on PDOC-123 Re: Support groups of parameters for HTML what is the recommended style of presentation - separate section with groups of parameters and a main alphabetical list, or something else? I'd suggest multiple lists - the existing "Parameters" list for ungrouped parameters, and an additional heading per group with the group name and bullet point list of parameters. Still, this would break the JSON API I think (since "group" would be a new concept). Adding group to "param" tag would be backwards compatible I think. Perhaps, but the schema doesn't list known tag_name types (https://github.com/puppetlabs/puppet-strings/blob/master/JSON.md#docstring-objects) so I think the anybody reading the JSON data has to be reasonably careful to search for tag_name types that they understand (certainly, that's what I've been doing.) Adding new ones ought to be straight forward, at least in a minor release rather than major. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-123) Support groups of parameters
Title: Message Title Henrik Lindberg commented on PDOC-123 Re: Support groups of parameters It makes sense in Json, it is just extra data - for HTML what is the recommended style of presentation - separate section with groups of parameters and a main alphabetical list, or something else? Still, this would break the JSON API I think (since "group" would be a new concept). Adding group to "param" tag would be backwards compatible I think. Add Comment This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.
Jira (PDOC-123) Support groups of parameters
Title: Message Title Dominic Cleal created an issue Puppet Strings / PDOC-123 Support groups of parameters Issue Type: Improvement Affects Versions: PDOC 0.99.0 Assignee: Unassigned Created: 2016/10/11 2:49 AM Priority: Normal Reporter: Dominic Cleal Support for grouping of parameters with a group name would be useful when documenting classes with tens of parameters, e.g. for "advanced parameters", "database connection parameters". It appears that YARD has @!group and @!endgroup directives already, so a doc format such as this might work: @!group Database connection @param db_adapter Database adapter name @param db_host Database server hostname
