Uploaded image for project: 'CFEngine Community'
  1. CFEngine Community
  2. CFE-3323

Macro for body attribute documentation

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Open
    • Priority: (None)
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None

      Description

      It would be nice if we had a macro that would expand body attribute type and valid input range documentation from cf-promises --syntax-description json to help keep the documentation up to date with core changes and regularly formatted.

      For example, the [%CFEngine_promise_attribute()%] macro (https://github.com/cfengine/documentation-generator/blob/8c6cff3bdfa72abb9d491e93e19b5313692fcd7e/_scripts/cfdoc_macros.py#L138) expands attribute type and allowed input range.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              a10042 Nick Anderson
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated: