Jira (PDOC-269) Support documenting required modules

2 views
Skip to first unread message

DO! DevOps (JIRA)

unread,
Oct 18, 2018, 4:55:03 AM10/18/18
to puppe...@googlegroups.com
DO! DevOps created an issue
 
Puppet Strings / New Feature PDOC-269
Support documenting required modules
Issue Type: New Feature New Feature
Assignee: Unassigned
Created: 2018/10/18 1:54 AM
Priority: Normal Normal
Reporter: DO! DevOps

It would be great if there was a tag to document forge modules that are used by the current class or type.

I'd suggest a @uses-module:

# @uses puppetlabs-stdlib 

This would render a link to the forge site of the puppetlabs-stdlib module.

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

Jesse Scott (JIRA)

unread,
Jun 11, 2019, 7:51:03 PM6/11/19
to puppe...@googlegroups.com
Jesse Scott commented on New Feature PDOC-269
 
Re: Support documenting required modules

This is an interesting idea, can you give us some examples of what type of code you are documenting where this would be useful? Is it that you just want more granularity than is expressed in the metadata.json dependencies of a module or are you using this to document role and profile code?

Reply all
Reply to author
Forward
0 new messages