docs: clarify that channels.release() is for niche use cases#3348
docs: clarify that channels.release() is for niche use cases#3348SimonWoolf merged 1 commit intomainfrom
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
m-hulbert
left a comment
There was a problem hiding this comment.
I know it might seem pedantic, but I think the comma here is important 🙂
Most users never need to call release(). Reframe the docs to match the recent spec update, discouraging general use and warning that using a channel reference after release is undefined behaviour. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
a73cbff to
2e667a7
Compare
|
@m-hulbert note that the wording has now changed significantly since you reviewed it since I noticed that the ably-js behaviour differed from all other SDKs and ended up changing that in the interests of uniformity, so am now documenting the new behaviour, cf ably/specification#448 (comment) |
Summary
channels.release()docs on both the Realtime and REST API pages to match the recent specification update.importantadmonition making clear that most applications should never callrelease— it exists for niche use cases (clients cycling through a continually changing set of channels).releaseis undefined behaviour.Test plan
/docs/api/realtime-sdk/channels#releaseand/docs/api/rest-sdk/channels#release.🤖 Generated with Claude Code