Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper assigned an issue to Nicholas Fagerlund Puppet Strings / PDOC-60 Strings skips docs for the log message functions Change By: William Hopper Status: Resolved Closed 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-60 Strings skips docs for the log message functions Change By: William Hopper Fix Version/s: PDOC 0.5.0 Fix Version/s: PDOC 0.99.0 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title Henrik Lindberg assigned an issue to Nicholas Fagerlund Puppet Strings / PDOC-60 Strings skips docs for the log message functions Change By: Henrik Lindberg Assignee: Nicholas Fagerlund 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-60 Strings skips docs for the log message functions Change By: William Hopper Attachment: screenshot-1.png 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper commented on PDOC-60 Re: Strings skips docs for the log message functions Puppet CI passed with the changes to the logging functions at https://jenkins.puppetlabs.com/job/platform_puppet_intn-van-sys_master/398/. This ticket probably still warrants a review from Nicholas Fagerlund before we resolve it. 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper commented on PDOC-60 Re: Strings skips docs for the log message functions PR is up at https://github.com/puppetlabs/puppet/pull/5299. PUP-6742 is the tracking puppet ticket. 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper commented on PDOC-60 Re: Strings skips docs for the log message functions Henrik Lindberg ah, good call. I'll investigate using the 4.x API with @!parse. We should be able to do the same thing with it. 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title Henrik Lindberg commented on PDOC-60 Re: Strings skips docs for the log message functions Solution 1 has the downside that it is using the 3.x function API as meta-meta here. Eventually we want to retire the 3.x function API. We then have an additional problem to solve. Solution 2 here we risk that functions in the function directory ends up being loaded and ending up in a different loader (by mistakes made in the future). This solution seems harder to maintain as a future change needs to go into all of the files. Here it is also unclear if it will actually work as the dispatcher is fake as the function reimplements the call method. To pursue on this path I think we need to create a new base class that the function inherits from so we can have a minimum of information in it (maintain the functionality in the base class). This seems like a lot of work at higher risk. Would using the 4.x API in the @!parse comments work? That would remove the only objection I had against Solution 1. 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper commented on PDOC-60 Re: Strings skips docs for the log message functions Henrik Lindberg alright, here are the two approaches we've got. Do you have thoughts on which you prefer? 1) Use the YARD parse directive (http://www.rubydoc.info/gems/yard/file/docs/Tags.md#parse) to give YARD a hint about what the metaprogrammed functions will be: https://gist.github.com/whopper/8c0439e55ccc7c13dbc9ce6a2dd7b482 This is a simple addition of comments, though it is a bit ugly as YARD doesn't have a mechanism to loop over an array of items. Otherwise, we wouldn't have needed to write out each function. 2) Break each of the functions into their own files and eval them in the static loader: https://gist.github.com/whopper/b0966df9e155b8fec12448918ff7e9b2 This requires us to find the proper way to evaluate the new functions in the static loader. For testing, we just used eval on the path to the function. 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper commented on PDOC-60 Re: Strings skips docs for the log message functions Jesse Scott came up with a few options for this today. On Monday we'll see what Henrik Lindberg thinks of them. 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper commented on PDOC-60 Re: Strings skips docs for the log message functions Henrik Lindberg makes sense - the only problem there is that create_logging_functions is private, so YARD won't pick it up 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title Henrik Lindberg commented on PDOC-60 Re: Strings skips docs for the log message functions Another possible approach is to use yard meta tags on the create_logging_functions method in static_loader.rb. And then get yard to scan and process those. Making them be free standing 3.x or 4.x functions (like all others) would work, but is not the best approach since the static loader is a bit special and we have no mechanism for directing functions being autoloaded to end up in the static loader. (just some thoughts) 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper commented on PDOC-60 Re: Strings skips docs for the log message functions Ah, thanks for the context Peter Huene - I'll look into separate definitions. 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title Peter Huene commented on PDOC-60 Re: Strings skips docs for the log message functions The Ruby function handler limits its detection to "namespace only" calls, which is why it won't see a call inside of a method. Users don't generally (if ever) dynamically generate functions, so there's probably a perf benefit for being "namespace only" (at least one would hope so given that it could skip over parsing method bodies entirely). When I originally mentioned the logging functions to Nick, we thought perhaps we'd have a special way of documenting dynamically generated functions (sort of like the directives we have for metaprogrammed resource type parameters/properties); alternatively, actually having separate definitions for these functions would enable us to document them differently (without an unsupported string interpolation) and make them easier to find in Puppet's source base. The latter I would advocate for. 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title
William Hopper commented on PDOC-60
Re: Strings skips docs for the log message functions
Another problem: strings can't seem to find instances of newfunction inside of a method. The following yields no puppet function output from strings:
def self.reset
# Runs a newfunction to create a function for each of the log levels
root_env = Puppet.lookup(:root_environment)
AnonymousModuleAdapter.clear(root_env)
Puppet::Parser::Functions::newfunction(:debug,
:environment => root_env,
:doc => "Log a message on the server at level debug.") do |vals|
send(:debug, vals.join(" "))
end
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper assigned an issue to William Hopper Puppet Strings / PDOC-60 Strings skips docs for the log message functions Change By: William Hopper Assignee: William Hopper 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper updated an issue Puppet Strings / PDOC-60 Strings skips docs for the log message functions Change By: William Hopper Sprint: PDS 2016-10-05 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title Henrik Lindberg commented on PDOC-60 Re: Strings skips docs for the log message functions Priority: This must be done in order to be able to replace the existing way of extracting the documentation. If not done there would be no documentation for the log functions on the docs site unless added manually. There are many different ways to solve this problem. A simple unroll is worth testing as it may be all that is needed. 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title William Hopper commented on PDOC-60 Re: Strings skips docs for the log message functions Todo: figure out priority on this. 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title Hailee Kenney updated an issue Puppet Strings / PDOC-60 Strings skips docs for the log message functions Change By: Hailee Kenney Story Points: 2 Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- 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.
Jira (PDOC-60) Strings skips docs for the log message functions
Title: Message Title Hailee Kenney updated an issue Puppet Strings / PDOC-60 Strings skips docs for the log message functions Change By: Hailee Kenney Fix Version/s: PDOC 0.5.0 Add Comment This message was sent by Atlassian JIRA (v6.4.13#64028-sha1:b7939e9) -- 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.
