Jira (PDOC-129) 4.x function overload tags not parsed if the overload is missing a docstring
Title: Message Title William Hopper created an issue Puppet Strings / PDOC-129 4.x function overload tags not parsed if the overload is missing a docstring Issue Type: Bug Assignee: Unassigned Created: 2016/10/19 2:07 PM Priority: Normal Reporter: William Hopper In the following function overload, if you remove the "Subtracts two integers" line, strings will ignore the rest of the @param and @return tags, but only in the JSON output, it seems. Puppet::Functions.create_function(:subtract) do # Subtracts two integers. # @param x The first integer. # @param y The second integer.
Jira (PDOC-129) 4.x function overload tags not parsed if the overload is missing a docstring
Title: Message Title William Hopper assigned an issue to William Hopper Puppet Strings / PDOC-129 4.x function overload tags not parsed if the overload is missing a docstring Change By: William Hopper Assignee: William Hopper 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-129) 4.x function overload tags not parsed if the overload is missing a docstring
Title: Message Title
William Hopper updated an issue
Puppet Strings / PDOC-129
4.x function overload tags not parsed if the overload is missing a docstring
Change By:
William Hopper
Acceptance Criteria:
Given the following 4.x function, both overloads in the JSON output should include a parameter and return tag:{code}# Subtracts two things.Puppet::Functions.create_function(:subtract) do # @param x The first integer. # @param y The second integer. # @return [Integer] Returns x - y. # @example Subtracting two integers. # subtract(5, 1) => 4 dispatch :subtract_ints doparam 'Integer', :xparam 'Integer', :y end # Here is a docstring # @param x The first array. # @param y The second array. # @return [Array] Returns x - y. # @example Subtracting two arrays. # subtract([3, 2, 1], [1]) => [3, 2] dispatch :subtract_arrays doparam 'Array', :xparam 'Array', :y end def subtract_ints(x, y)x - y end def subtract_arrays(x, y)x - y endend{code}
Story Points:
1
Sprint:
PDS 2016-11-16
Fix Version/s:
PDOC 1.0.0
Add Comment
This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe)
Jira (PDOC-129) 4.x function overload tags not parsed if the overload is missing a docstring
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-129 4.x function overload tags not parsed if the overload is missing a docstring Change By: William Hopper Release Notes: Not Needed 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-129) 4.x function overload tags not parsed if the overload is missing a docstring
Title: Message Title William Hopper assigned an issue to qa Puppet Strings / PDOC-129 4.x function overload tags not parsed if the overload is missing a docstring Change By: William Hopper Status: Ready for CI Test Assignee: qa 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-129) 4.x function overload tags not parsed if the overload is missing a docstring
Title: Message Title Eric Thompson updated an issue Puppet Strings / PDOC-129 4.x function overload tags not parsed if the overload is missing a docstring Change By: Eric Thompson QA Status: Reviewed 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-129) 4.x function overload tags not parsed if the overload is missing a docstring
Title: Message Title Eric Thompson updated an issue Puppet Strings / PDOC-129 4.x function overload tags not parsed if the overload is missing a docstring Change By: Eric Thompson QA Risk Assessment: Medium 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-129) 4.x function overload tags not parsed if the overload is missing a docstring
Title: Message Title Eric Thompson updated an issue Puppet Strings / PDOC-129 4.x function overload tags not parsed if the overload is missing a docstring Change By: Eric Thompson QA Risk Assessment Reason: covered well in existing unit tests. PR updates fixtures. 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.
