Uploaded image for project: 'Puppet'
  1. Puppet
  2. PUP-6742

Add YARD tags for puppet log functions (debug, info, notice, etc)

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PUP 4.8.0
    • Component/s: None
    • Labels:
      None
    • Template:
    • Acceptance Criteria:
      Hide

      puppet-strings should be able to document the 8 puppet log functions: debug, info, notice, warning, err, alert, emerg and crit. The docs should be of the same quality as existing docs, such as https://docs.puppet.com/puppet/4.7/reference/function.html#debug, though without the type info as puppet uses the 4.X API to create these functions, and type as it is seen on that page is a 3.x construct.

      Show
      puppet-strings should be able to document the 8 puppet log functions: debug, info, notice, warning, err, alert, emerg and crit. The docs should be of the same quality as existing docs, such as https://docs.puppet.com/puppet/4.7/reference/function.html#debug , though without the type info as puppet uses the 4.X API to create these functions, and type as it is seen on that page is a 3.x construct.
    • Team:
      Puppet Developer Experience
    • Story Points:
      1
    • Sprint:
      PDS 2016-10-05

      Description

      Currently, the dynamically created log functions (debug, info, notice, etc) can't be documented by puppet-strings, as YARD does not evaluate Ruby code at runtime.

      YARD has a @!parse directive which is meant for metaprogrammed constructs. We can use it to give YARD hints about what the metaprogrammed classes will be.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                whopper William Hopper
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Zendesk Support