Uploaded image for project: 'Puppet Strings'
  1. Puppet Strings
  2. PDOC-273

puppet-strings should pull documentation from the lib folder too

    Details

    • Type: Bug
    • Status: Accepted
    • Priority: Normal
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:
    • Template:
    • Method Found:
      Needs Assessment
    • QA Risk Assessment:
      Needs Assessment

      Description

      As a module author I write my documentation in a format compatible with puppet strings. I expect that when I run puppet strings generate that all that documentation will end up in REFERENCE.md however none of the docs that I write on the ruby files in the lib folder are processed. The end result of this is a need to manually document part of my module while having the rest of the docs auto-generated. 

        Attachments

          Activity

            People

            • Assignee:
              kris.bosland Kris Bosland
              Reporter:
              gene.liverman Gene Liverman
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:

                Zendesk Support