> > > We've set YARD up so that documentation is only generated for methods and > classes with an '@api' tag. When we switched to using YARD we decided to > take that approach because there were so many comments interpreted as > documentation that were either blatantly wrong or not documentation at all. > Any effort toward improving docs is welcome. >
Makes sense; missing api tags at fault. And with respect to the yardoc, we could define a new yard tag like > `@callback [caller] description` or something to that. I think that could be very useful. Assuming available time, I may take a stab at this in the next few weeks, or at least shoring up some of the already existing docs (e.g. add missing @api tags). With respect to your original pull request, what about > `transaction_teardown` or something like that? After this discussion, I'm now thinking something like 'post_resource_eval'. 'teardown' might be a little too narrow to describe what you might use this function for. Thoughts/objections (barring those, I'll update the PR)? Eric -- You received this message because you are subscribed to the Google Groups "Puppet Developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/puppet-dev. For more options, visit https://groups.google.com/groups/opt_out.
