Jira (PDOC-265) @example doesn't work with 4.x functions
Title: Message Title Jean Bond commented on PDOC-265 Re: @example doesn't work with 4.x functions Jesse Scott, yes, I think that sounds like the right move to me. 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-265) @example doesn't work with 4.x functions
Title: Message Title Jesse Scott commented on PDOC-265 Re: @example doesn't work with 4.x functions Jean Bond It sounds like maybe the original issue (that puppet-strings didn't recognize the @example tag at all for 4.x style functions) has been fixed but there may still be a bug in how it's able to capture example content that contains blank lines? If that's the case can we open a new ticket specifically about that issue and close this one? 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-265) @example doesn't work with 4.x functions
Title: Message Title Jean Bond commented on PDOC-265 Re: @example doesn't work with 4.x functions Good catch, Henrik Lindberg, that might be part of the issue. I've PR'd a fix to that. There's still a lot of other descriptive text not getting picked up, but maybe this will fix the example issue. 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-265) @example doesn't work with 4.x functions
Title: Message Title Henrik Lindberg commented on PDOC-265 Re: @example doesn't work with 4.x functions Examples in regsubst.rb (the 4.x implementation) looks like this: # @example Get the third octet from the node's IP address: # # ```puppet # $i3 = regsubst($ipaddress,'^(\\d+)\\.(\\d+)\\.(\\d+)\\.(\\d+)$','\\3') # ``` # # @example Put angle brackets around each octet in the node's IP address: # # ```puppet # $x = regsubst($ipaddress, /([0-9]+)/, '<\\1>', 'G') # ``` Note that the example body is one blank line away and not indented. Is that what is causing Puppet Strings to not pick it up? Or is it something else?
Jira (PDOC-265) @example doesn't work with 4.x functions
Title: Message Title Jean Bond assigned an issue to Unassigned Puppet Strings / PDOC-265 @example doesn't work with 4.x functions Change By: Jean Bond Assignee: Jean Bond 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-265) @example doesn't work with 4.x functions
Title: Message Title Jean Bond commented on PDOC-265 Re: @example doesn't work with 4.x functions This does not appear to have fixed the issue with core docs generation. It may be a Strings thing or it may be an issue with the docs scripts. The function in Puppet code contains a lot of comment text that is seen in the 5.3 example (https://puppet.com/docs/puppet/5.3/function.html#regsubst) but is not showing up in the 6.4 generated docs (https://puppet.com/docs/puppet/6.4/function.html#regsubst). This includes, but is not limited to, the descriptions of the examples. When I generate docs, I get two files for functions: function_strings_prefer_v3.md: this contains the comment text and @example descriptions from the function. function_strings_prefer_v4.md: this... doesn't. It's the function_strings_prefer_v4.md file that becomes functions.html. I'm a little vague on what the difference is between the two files (Puppet 3 vs Puppet 4, I imagine?) because I'm still learning about how the generated docs work. Anyway, pinging Kris Bosland, as he's been helping recently on working out some of the bugs with generated docs. 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
Jira (PDOC-265) @example doesn't work with 4.x functions
Title: Message Title Jean Bond commented on PDOC-265 Re: @example doesn't work with 4.x functions I'm hoping this recent release fixes the function issue in the core function docs. I'm assigning myself to this ticket for testing. 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-265) @example doesn't work with 4.x functions
Title: Message Title Jean Bond assigned an issue to Jean Bond Puppet Strings / PDOC-265 @example doesn't work with 4.x functions Change By: Jean Bond Assignee: Jean Bond 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-265) @example doesn't work with 4.x functions
Title: Message Title Alexander Fisher commented on PDOC-265 Re: @example doesn't work with 4.x functions This is fixed in the recently released puppet strings 2.2 https://github.com/puppetlabs/puppet-strings/pull/188 I'm interested to see how the core function documentation is affected. I think the problem will be that because puppet-strings was missing the functionality, people have been trying their best to work around the limitations. eg. https://github.com/puppetlabs/puppet/blob/80e14013537dd238862cb0d97db5952e840f0f48/lib/puppet/functions/regsubst.rb#L29-L40 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-265) @example doesn't work with 4.x functions
Title: Message Title Michelle Fredette commented on PDOC-265 Re: @example doesn't work with 4.x functions Jean Bond do you have any status on the strings work? 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-265) @example doesn't work with 4.x functions
Title: Message Title Ben Ford commented on PDOC-265 Re: @example doesn't work with 4.x functions Yes, the regsubst docs on the docs site are in pretty poor state. What do we need to do to prioritize fixing this? 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-265) @example doesn't work with 4.x functions
Title: Message Title Henrik Lindberg commented on PDOC-265 Re: @example doesn't work with 4.x functions Alexander Fisher Thanks for testing. 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-265) @example doesn't work with 4.x functions
Title: Message Title Alexander Fisher commented on PDOC-265 Re: @example doesn't work with 4.x functions Henrik Lindberg I have now, and it didn't make any difference. 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-265) @example doesn't work with 4.x functions
Title: Message Title Henrik Lindberg commented on PDOC-265 Re: @example doesn't work with 4.x functions Have you tried placing the @example above the @param ? (not sure it helps, but just a thought). This needs to be fixed - we were looking at the output for the regsubst function in puppet, and documentation for it is not coming out right either (it has @example tags as well) 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-265) @example doesn't work with 4.x functions
Title: Message Title Alexander Fisher commented on PDOC-265 Re: @example doesn't work with 4.x functions Affects-version should be 2.1.0, but that wasn't available in the dropdown. 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-265) @example doesn't work with 4.x functions
Title: Message Title Alexander Fisher created an issue Puppet Strings / PDOC-265 @example doesn't work with 4.x functions Issue Type: Bug Affects Versions: 2.0.0 Assignee: Unassigned Created: 2018/09/07 7:22 AM Priority: Normal Reporter: Alexander Fisher The style guide shows you how you're supposed to use puppet-strings with 4.x functions. # An example 4.x function. Puppet::Functions.create_function(:example) do # @param first The first parameter. # @param second The second parameter. # @return [String] Returns a string. # @example Calling the function
