Issue #1874 has been updated by jamtur01. Category set to documentation Status changed from Unreviewed to Accepted Assigned to set to masterzen Target version set to 0.25.0
---------------------------------------- Bug #1874: ReST formatting of function documentation isn't retained http://projects.reductivelabs.com/issues/show/1874 Author: [email protected] Status: Accepted Priority: Normal Assigned to: masterzen Category: documentation Target version: 0.25.0 Complexity: Unknown Affected version: 0.24.7 Keywords: When running 'puppetdoc -r function', puppetdoc strips newlines and indentation of the function doc-strings. This makes it impossible to use for example paragraphs or bullet lists in the documentation. While none of the current functions actually need that, there are some upcoming functions with many parameters that will need better formatting. Among the current functions, the defined() and generate() functions have multiline doc-strings. When comparing the docstrings in the Ruby source code to the output from puppetdoc, you can easily see that newlines and indentation is stripped. ---------------------------------------- You have received this notification because you have either subscribed to it, or are involved in it. To change your notification preferences, please click here: http://reductivelabs.com/redmine/my/account --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/puppet-bugs?hl=en -~----------~----~----~----~------~----~------~--~---
