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

reorganize documentation of function 'new'

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Accepted
    • Priority: Normal
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: PUP 5.y
    • Component/s: None
    • Labels:
      None
    • Template:
    • Sub-team:
    • Team:
      Froyo
    • Release Notes:
      Not Needed
    • Release Notes Summary:
      Part of a larger feature (new / Object type / Pcore).

      Description

      The documentation of the function new is not well organized. This is a problem because it is currently the only way for the various new operations on types to surface their documentation.

      With the recent addition of SemVer and SemVerRange it became clear that a reorganization is needed. An index should be added that more clearly shows the conversions to/from types and for types where it is more of just an instantiation.

      This ticket blocks the documentation work for SemVer and SemVerRange types.

      Longer term, we must have a way to generate the documentation for types and their operations.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned
              Reporter:
              henrik.lindberg Henrik Lindberg
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:

                  Zendesk Support