Jira (PDOC-288) markdown summary uses too much summary text and truncates
Title: Message Title Henrik Lindberg created an issue Puppet Strings / PDOC-288 markdown summary uses too much summary text and truncates Issue Type: Bug Assignee: Unassigned Created: 2019/08/18 2:53 AM Priority: Normal Reporter: Henrik Lindberg The summary / index for functions that is generated when producing markdown contains too much text and truncates it. For example: tahu::attributes: Returns the instance attributes of an Object or Type. An instance attribute is an attribute of a value. Only Object values have inst For documentation that looks like this: # Returns the instance attributes of an `Object` or `Type`. # # An *instance attribute* is an attribute of a value. Only `Object` values have
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)
