COEL - Normative - Misuse of MUST 3.2.2 Artefact Style Guide

XMLWordPrintable

    • Hide

      String descriptions begin with the first word capitalised.

      (BTW, I have no idea what was meant by "with no punctuation, abbreviations or trailing spaces." What does that have to do with capitalization?)

      Cluster names are single words with no whitespaces. (Refer to whitespace as defined by RFC4627, 2. JSON Grammar. The term "spaces" is ambiguous.

      Show
      String descriptions begin with the first word capitalised. (BTW, I have no idea what was meant by "with no punctuation, abbreviations or trailing spaces." What does that have to do with capitalization?) Cluster names are single words with no whitespaces. (Refer to whitespace as defined by RFC4627, 2. JSON Grammar. The term "spaces" is ambiguous.

      3.2.2 Artefact Style Guide reads:

      *****
      The string descriptions MUST be formatted with only the first word capitalised with no punctuation, abbreviations or trailing spaces. The Clusters MUST be single words with no spaces.
      *****

      The control word "MUST" is not needed here. The normative text of a standard states the rules for constructing names/values, etc. MUST is only required in conformance clauses.

      BTW, don't use the definite article "the" when you want to refer to any possible string description or cluster.

      See the proposal for a re-write.

            Assignee:
            Unassigned
            Reporter:
            Chet Ensign
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: