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

puppet describe does not show top-level docs

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: PUP 5.5.16, PUP 6.9.0
    • Fix Version/s: None
    • Component/s: None
    • Labels:
    • Template:
    • Team:
      Coremunity
    • Method Found:
      Needs Assessment
    • Release Notes:
      Bug Fix
    • Release Notes Summary:
      Resource API types now display their top-level documentation when listed and inspected with `puppet describe`.
    • QA Risk Assessment:
      Needs Assessment

      Description

      As the example below shows, the puppet describe command doesn't pick up top-level documentation from the blubb type:

      david@davids:~/git/tmp/blubb$ bundle exec -- puppet describe --modulepath spec/fixtures/modules/ --list | grep blubb
      blubb           - .. no documentation ..
      david@davids:~/git/tmp/blubb$ bundle exec -- puppet describe --modulepath spec/fixtures/modules/ blubb
       
      blubb
      =====
       
       
       
      Parameters
      ----------
       
      - **blubb**
          the hot sht. (a Boolean)
          Valid values are `true` (also called `true, true`), `false` (also called
          `false, false`). 
       
      - **ensure**
          Whether this resource should be present or absent on the target system.
          (a Enum[present, absent])
      Valid values are `absent`, `present`. 
       
      - **flubb**
          the cold sht. (a Integer)
      Values can match `/^-?\d+$/`.
       
      - **name**
          The name of the resource you want to manage. (a String)
          Values can match `//`.
      david@davids:~/git/tmp/blubb$ 
      

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              david.schmitt David Schmitt
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support