search

mqtt / mqtt.org

The mqtt.org website
https://mqtt.org
5.07k stars 930 forks source link

MQTT v5.0 Specification Typos #196

Open dylan-hart opened 6 months ago

dylan-hart commented 6 months ago

These are all very minor, so I don't expect any interest in addressing them, but I thought it might be good to report. These are all from the MQTT v5.0 PDF available at https://mqtt.org/mqtt-specification/.

L1167: "The values the Connect Reason Code are shown below" is inconsistent with similar statements in the spec (L2463, L2541, L2642). Expected: "The values [for] the Connect Reason Code are shown below."

L1199 "... other than that sent by the Client in the CONNACK" seems to suggest the Client would send a CONNACK to the server. Expected: "... other than that sent by the Client in the CONNECT."

L1328: "A value is 0 means ..." Expected: "A value [of] 0 means ..."

L1344: "A value is 0 means ..." Expected: "A value [of] 0 means ..."

L1555: "Payload Forma t Indicator" (space in the word Format) Expected: "Payload Format Indicator"

L1568: "Message Expiry Interval`" (tilde following the word Interval) Expected: "Message Expiry Interval"

L1741, [MQTT-3.3.4-4] "... which have a Subscription Identifiers, their" (pluralization) Expected: "... which have a Subscription Identifier, their"

It seems likely I'll find more as I continue reading. Are any of these helpful? Is there a better method or place for me to report them?

dylan-hart commented 6 months ago

More:

L2170: "Figure 3.21 show the ..." Expected: "Figure 3.21 [shows] the ..."

L2705: "The Clients subscriptions ..." Expected: "The Client's subscriptions ..."

L2898: "The following these rules apply to ..." Expected: "The following rules apply to ..."

L2910: "... are received are in the order they were published." Expected: "... are received in the order they were published."

L2913: "This is addition to the rules listed above." Expected: "This is [in] addition to the rules listed above."

L3145: "... in the same that it does ..." Expected: "... in the same [way/manner] that it does ..."

L3145: "... to a -Subscriber." Expected: "... to a Non-shared Subscriber."

L3156: "Client'sSession ..." Expected: "Client's Session ..."

L3319: "... the expectation is that that Client will choose ..." is inconsistent with other references to "the Client" (L3294, L3298, L3299) Expected: "... the expectation is that the Client will choose ..."

L3441: "Definitions of Malformed Packet and Protocol Errors are contained in section 1.2 Terminology, some but not all, of these error cases are noted throughout the specification." This is a run-on sentence, and could be improved by splitting the two distinct thoughts into separate sentences. Expected: "Definitions of Malformed Packet and Protocol Errors are contained in section 1.2 Terminology. Some, but not all, of these error cases are noted throughout the specification.