Skip to content

chore: fix typographical errors and improve consistency in features.md#438

Merged
ttypic merged 1 commit intomainfrom
fix-markdown-issues
Mar 11, 2026
Merged

chore: fix typographical errors and improve consistency in features.md#438
ttypic merged 1 commit intomainfrom
fix-markdown-issues

Conversation

@ttypic
Copy link
Contributor

@ttypic ttypic commented Mar 11, 2026

  • Corrected formatting issues (annotations, '@' characters, etc.).
  • Improved consistency in spec point references and removed redundant/unnecessary characters.

@ttypic ttypic requested a review from VeskeR March 11, 2026 15:37
@ttypic ttypic marked this pull request as ready for review March 11, 2026 15:37
@github-actions github-actions bot temporarily deployed to staging/pull/438 March 11, 2026 15:38 Inactive
- `(RSL1h)` The `publish(name, data)` form should not take any additional arguments. If a client library has supported additional arguments to the `(name, data)` form (e.g. separate arguments for `clientId` and `extras`, or a single `attributes` argument) in any 1.x version, it should continue to do so until version 2.0.
- `(RSL1i)` If the total size of the message or (if publishing an array) messages, calculated per [TO3l8](#TO3l8), exceeds the `maxMessageSize`, then the client library should reject the publish and indicate an error with code 40009
- `(RSL1j)` When `Message` objects are provided, any valid `Message` attribute (that is, an attribute specified in [TM2](#TM2)) that is supplied by the caller must be included in the encoded message. (This does not mean it must be included *unaltered*; for example the `data` and `encoding` will be subject to processing per [RSL4](#RSL4))
- `(RSL1j)` When `Message` objects are provided, any valid `Message` attribute (that is, an attribute specified in [TM2](#TM2)) that is supplied by the caller must be included in the encoded message, with the exception of the `annotations` field (`TM2u`) which must never be serialized when sending a message to Ably. (This does not mean other attributes must be included *unaltered*; for example the `data` and `encoding` will be subject to processing per [RSL4](#RSL4))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with the exception of the annotations field (TM2u) which must never be serialized when sending a message to Ably

where did this come from?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, sorry, it's true, but it was unstashed changes, I'll revert

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rollbacked this!

- Corrected formatting issues (`annotations`, `'@'` characters, etc.).
- Improved consistency in spec point references and removed redundant/unnecessary characters.
@ttypic ttypic merged commit 6151d63 into main Mar 11, 2026
2 checks passed
@ttypic ttypic deleted the fix-markdown-issues branch March 11, 2026 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants