Issue #2266 has been reported by Thomas Bellman.

----------------------------------------
Bug #2266: Broken docstring formatting
http://projects.reductivelabs.com/issues/2266

Author: Thomas Bellman
Status: Unreviewed
Priority: Normal
Assigned to: Thomas Bellman
Category: documentation
Target version: 0.25.0
Complexity: Easy
Affected version: 0.24.8
Keywords: 


When puppetdoc extracts docstrings from the source code, it tries to determine 
a "consistent indentation" that the docstring has.  However, it doesn't quite 
work as it should.  It finds the first indented line in the docstring, 
regardless of if there are many unindented lines before it, and believes that 
its indentation should be stripped from all lines.  That can break definition 
lists.

It also mistakenly believes newline is indentation, and can thus cause 
paragraphs to run into each other.  This happens to the documentation for the 
split() functions.


-- 
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
-~----------~----~----~----~------~----~------~--~---

Reply via email to