Issue #1664 has been updated by masterzen. Status changed from Accepted to Ready for Testing Assigned to changed from masterzen to jamtur01 Target version changed from unplanned to 0.24.7 Complexity changed from Unknown to Medium
Hi, Luke seems to think it is now mature enough to be integrated into 0.24.x. The code is 0.24.x based (as of today) and is available in the feature/inline-doc branch of my github repository: http://github.com/masterzen/puppet/tree/feature%2Finline-doc Thanks, ---------------------------------------- Feature #1664: Puppet manifests should support inline documentation http://projects.reductivelabs.com/issues/show/1664 Author: luke Status: Ready for Testing Priority: Normal Assigned to: jamtur01 Category: documentation Target version: 0.24.7 Complexity: Medium Affected version: 0.24.4 Keywords: This would be something like rdoc or perldoc. I'd definitely prefer that we pick a markup language that already exists -- really, I'd prefer Restructured Text, but it's not an option because there's no Ruby parser, so I guess Markdown is the best option. This should be pretty straightforward -- just keep track of any contiguous comments (emptying the cache on any blank lines), and every time an AST instance is created, check the comment cache and attach it as docs if it's not empty. It should be adding a 'doc' attribute to the AST base class (use Util::Docs, I think), and then adding the connection between the cache and the syntax instance to the parser, I think. Then we need an executable (probably extend puppetdoc rather than making a new one) that can extract them from a single manifest, a module, or a module path, and create (at least to start) html from them all. ---------------------------------------- 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 -~----------~----~----~----~------~----~------~--~---
