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

improve files promises docs (file_select specifically)

    XMLWordPrintable

    Details

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

      Description

      I was trying to write a file_select body and had no idea/clue that a file_result was needed.

      There is no description starting at https://docs.cfengine.com/docs/3.15/reference-promise-types-files.html#file_select but just jumps right in to a bunch of random attributes and examples. No "basis".

       

      Even the text at https://docs.cfengine.com/docs/3.15/reference-promise-types-files.html#file_result doesn't make it very clear that it is "required"? Or is it?

       

      So likely what we need is some descriptive text at the file_select anchor which explains how it works. That you add various attributes to filter the list and that you should return the results based on classes-like things related to those various attributes.

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            craig.comstock Craig Comstock
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: