Jira (PDOC-130) linebreaks cause problems

[William Yardley (JIRA)]

Title: Message Title

William Yardley created an issue   Puppet Strings / PDOC-130 linebreaks cause problems Issue Type: Bug Affects Versions: PDOC 0.99.0 Assignee: Unassigned Created: 2016/10/24 9:27 PM Priority: Normal Reporter: William Yardley Creating long descriptions doesn't seem to work optimally; typically, I'd want to wrap at 80 or 140 characters, but a newline seems to confuse puppet-strings. If this is expected behavior, the limitation should be documented better. For example, if you try to wrap lines for a long description, e.g., # @param package_source [String] The source for the package. Possible values # are undef (default), meaning the package will be installed from the # vendor's packaging system using configured repos. On supported platforms, # this can also be set to: # 'nginx-stable': (current production release from official repository) # 'nginx-mainline': (current development release from official repository) # 'passenger': (Phusion Passenger repos) and generate the pages using the example command, the parameter text is truncated, and the extra text shows up in an unexpected place (in this example, under Overview) Unable to render embedded object: File (puppet-strings1.png) not found. I would also love to see at least one official Puppet module documented using puppet-strings, having a concrete example would be really useful. 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.