Minor readme fixes.

[maratal]

I'd avoid mentioning bufferingPolicy in the README at all. Users can find later in the docs IMHO.

Summary by CodeRabbit

• Documentation
  • Updated method signatures for subscription handling in the Ably Chat SDK documentation, simplifying usage.
  • Clarified that presence data can now be a nested dictionary when entering presence.

[coderabbitai]

Walkthrough

The changes in this pull request primarily focus on updating the README.md documentation for the Ably Chat SDK. Key modifications include the removal of the bufferingPolicy: .unbounded argument from various subscription method signatures, simplifying their usage. Additionally, the method for stopping subscriptions has been changed from finish to unsubscribe, and the documentation now specifies that presence data can be represented as a nested dictionary.

Changes

File	Change Summary
README.md	- Updated method signatures to remove bufferingPolicy: .unbounded from subscription methods.
	- Changed subscription.finish() to subscription.unsubscribe().
	- Clarified that presence data can now be a nested dictionary when entering presence.

Possibly related PRs

• [ECO-5102] Updated README #166: The changes in this PR also involve updates to the README.md file, focusing on enhancing the documentation for the Ably Chat SDK, which may include similar method calls and subscription handling updates.

Suggested reviewers

• ttypic
• lawrence-forooghian
• umair-ably

🐇 In the meadow, changes bloom,
Simplified calls, we make room.
Subscriptions now, a clearer sight,
Unsubscribe brings joy, delight!
With nested data, we hop and play,
In our SDK, a brighter day! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7792e5a and 8ae80a8.

📒 Files selected for processing (1)

• README.md (10 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[umair-ably]

nice!

[coderabbitai]

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (2)

README.md (2)

Line range hint 408-412: Update unsubscription method reference

The subscription example is correct, but the text below still refers to the finish method instead of unsubscribe.

-To stop listening for the typing events, call the `finish` method on the returned subscription instance.
+To stop listening for the typing events, call the `unsubscribe` method on the returned subscription instance.

---

Line range hint 425-429: Update unsubscription method reference

The subscription example is correct, but the text still refers to the finish method instead of unsubscribe.

-To stop listening for the typing events, call the `finish` method on the returned subscription instance.
+To stop listening for the occupancy events, call the `unsubscribe` method on the returned subscription instance.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cdd61d1 and 7792e5a.

📒 Files selected for processing (1)

• README.md (8 hunks)

🔇 Additional comments (5)

README.md (5)

109-111: LGTM! Method signature simplified

The removal of the bufferingPolicy parameter simplifies the API while maintaining the same functionality.

---

115-115: LGTM! Method name improved for clarity

The change from finish() to unsubscribe() makes the API more intuitive and consistent with common SDK patterns.

Also applies to: 118-118

---

Line range hint 294-303: LGTM! Clear example of message history retrieval

The example clearly demonstrates subscription, pagination, and error handling.

---

327-327: LGTM! Helpful clarification about data structure

The added note about nested dictionary support is valuable for developers.

---

467-470: ⚠️ Potential issue

Update unsubscription method reference

The subscription example is correct, but the text below still refers to the finish method instead of unsubscribe.

-To stop receiving reactions, call the `finish` method on the returned subscription instance.
+To stop receiving reactions, call the `unsubscribe` method on the returned subscription instance.

Likely invalid or redundant comment.