Jira (PDOC-287) Ruby 4.x function with single dispatch gets docs generated twice
Title: Message Title Jesse Scott updated an issue Puppet Strings / PDOC-287 Ruby 4.x function with single dispatch gets docs generated twice Change By: Jesse Scott Labels: 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. To view this discussion on the web visit https://groups.google.com/d/msgid/puppet-bugs/JIRA.321353.1566119361000.64872.1566344640339%40Atlassian.JIRA.
Jira (PDOC-287) Ruby 4.x function with single dispatch gets docs generated twice
Title: Message Title Jean Bond updated an issue Puppet Strings / PDOC-287 Ruby 4.x function with single dispatch gets docs generated twice Change By: Jean Bond Labels: 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. To view this discussion on the web visit https://groups.google.com/d/msgid/puppet-bugs/JIRA.321353.1566119361000.64869.1566344640323%40Atlassian.JIRA.
Jira (PDOC-287) Ruby 4.x function with single dispatch gets docs generated twice
Title: Message Title Jean Bond commented on PDOC-287 Re: Ruby 4.x function with single dispatch gets docs generated twice Thank you for checking Henrik Lindberg! 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 view this discussion on the web visit https://groups.google.com/d/msgid/puppet-bugs/JIRA.321353.1566119361000.60894.1566234240490%40Atlassian.JIRA.
Jira (PDOC-287) Ruby 4.x function with single dispatch gets docs generated twice
Title: Message Title Henrik Lindberg commented on PDOC-287 Re: Ruby 4.x function with single dispatch gets docs generated twice Jean Bond None of the suggested changes make any difference - the output is identical. 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 view this discussion on the web visit https://groups.google.com/d/msgid/puppet-bugs/JIRA.321353.1566119361000.60857.1566233460206%40Atlassian.JIRA.
Jira (PDOC-287) Ruby 4.x function with single dispatch gets docs generated twice
Title: Message Title Jean Bond commented on PDOC-287 Re: Ruby 4.x function with single dispatch gets docs generated twice Hi Henrik Lindberg! I'm wondering if this is a formatting issue. For a Ruby function, tags should go before the dispatch call. Also, I believe that there should be no lines between the `Puppet::Function...` and the following Strings tags. Can you please check to see if that fixes the issue, and let us know here? So: # Converts a value from a `RichData` compliant data structure to the actual runtime values. # This function is useful as deserialization of a rich data structure - for example something read from # a yaml file. This is the reverse of `tahu::convert_to_rich_data()`. # # See # * `tahu::convert_to_rich_data` for how to serialize. # * [Pcore Data Representation Specification](https://github.com/puppetlabs/puppet-specifications/blob/master/language/data-types/pcore-data-representation.md) Puppet::Functions.create_function(:'tahu::convert_from_rich_data', Puppet::Functions::InternalFunction) do # @example Deserializing a value #$r = /this is a regexp/ #$serialized = tahu::convert_to_rich_data($r)
Jira (PDOC-287) Ruby 4.x function with single dispatch gets docs generated twice
Title: Message Title Henrik Lindberg commented on PDOC-287 Re: Ruby 4.x function with single dispatch gets docs generated twice Example that results in bad output: # Converts a value from a `RichData` compliant data structure to the actual runtime values. # # This function is useful as deserialization of a rich data structure - for example something read from # a yaml file. This is the reverse of `tahu::convert_to_rich_data()`. # # See # * `tahu::convert_to_rich_data` for how to serialize. # * [Pcore Data Representation Specification](https://github.com/puppetlabs/puppet-specifications/blob/master/language/data-types/pcore-data-representation.md) # # # @example Deserializing a value # $r = /this is a regexp/ # $serialized = tahu::convert_to_rich_data($r)
Jira (PDOC-287) Ruby 4.x function with single dispatch gets docs generated twice
Title: Message Title Henrik Lindberg created an issue Puppet Strings / PDOC-287 Ruby 4.x function with single dispatch gets docs generated twice Issue Type: Bug Assignee: Unassigned Created: 2019/08/18 2:09 AM Priority: Normal Reporter: Henrik Lindberg For a 4.x function with a single dispatch and where there is documentation for the entire function, then the entire documentation is output twice - once for the function and once for the single dispatch signature. Adding a second dispatch results in the function level documentation to be output only once. Tested with markdown format output. Add Comment This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
