WD4: Minor suggestions in sections 2.3.3.X

XMLWordPrintable

    • Type: Bug
    • Resolution: Fixed
    • Priority: Trivial
    • 5
    • Affects Version/s: 5
    • Component/s: edits
    • None
    • Hide

      Line 671: Left as is. I tried to avoid the use of the word "optional" because this can be interpreted as meaning that the implementation is optional, whereas if the id/value is present it must be acted on.

      Line 672: Left as is. This is a generic description if Id/Value pairs, I suspect it would be less clear if we merged it all into a single paragraph.

      Lines 674-675 : Fixed.

      Lines 676-677 Using MAY implies that there are alternative implementations. I'll rephrase it to say that the order is not significant.

      Lines 681-682: Fixed.

      Line 684: Fixed.

      Show
      Line 671: Left as is. I tried to avoid the use of the word "optional" because this can be interpreted as meaning that the implementation is optional, whereas if the id/value is present it must be acted on. Line 672: Left as is. This is a generic description if Id/Value pairs, I suspect it would be less clear if we merged it all into a single paragraph. Lines 674-675 : Fixed. Lines 676-677 Using MAY implies that there are alternative implementations. I'll rephrase it to say that the order is not significant. Lines 681-682: Fixed. Line 684: Fixed.

      Line 671:

      The CONNECT, CONNACK, PUBLISH and DISCONNECT Packet variable header ends with a set of Identifier/Value pairs, this is made up of a length field followed by the Identifier/Value pairs themselves.

      Proposed: The CONNECT, CONNACK, PUBLISH, and DISCONNECT Packet variable headers end with an optional set of Identifier/Value pairs.

      Line 672:

      ... this is made up of a length field followed by the Identifier/Value pairs themselves.

      Note: It feels redundant to discuss the composition since it is then immediately described in the following section - 2.3.3.1?

      Lines 674-675
      The length or the Identifier/Value fields does not include ...

      Proposed: "The length of the ..."

      Lines 676-677
      The Identifier/Value pairs can appear in any order.

      Proposed: The Identifier/Value pairs MAY appear in any order.

      Lines 681-682:

      On receipt of an Identifier or Value, that is not defined for the Packet the receiver MUST close the network connection.

      Proposed: On receipt of an Identifier or Value that is not defined for the Packet, the receiver MUST close the network connection.

      Line 684: In this specification, only one-byte Identifier's are used.

      Proposed: "one-byte Identifiers".

            Assignee:
            Andrew Banks (Inactive)
            Reporter:
            brianraymor
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: