The description column does not server its purpose

XMLWordPrintableJSON

    • Type: Change Request
    • Resolution: Persuasive with Modification

      In the table the Description column does not seem to serve its purpose. (This also holds for many other tables describing parameters)

      First, why is REQUIRED capitalized and prohibites is not? I would suggest to unify these.

      Second, the description is supposed to explain the paremater purpose. The additional restrictions on when the parameter may or may not be used I would expect to be placed in either a different table - as it is action specific or in the same table but in different column such as Constrains.

      Third, the table has already a column Optionality which states that the parameter is optional. Yet in the Description it is stated that in some cases it is required. This gives me a feeling that the structure of presenting the action parameters is not thought through thoroughly enough. I would much rather prefer table where I see when the parameter is required and when it is optional and when it is not but with no additional constrains in the Description because whis way looking at the optionality colunm is not enough to get a complete idea of the parameter's optionality.

      Existing Wording:

      REQUIRED for scratchpad.create and scratchpad.update. Prohibited for scratchpad.delete.

            Assignee:
            Unassigned
            Reporter:
            ivan_zapreev
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: