Rewind param: stop making the non-ably-sdk fallback method the first thing we tell people about#3334
Open
SimonWoolf wants to merge 2 commits intomainfrom
Open
Rewind param: stop making the non-ably-sdk fallback method the first thing we tell people about#3334SimonWoolf wants to merge 2 commits intomainfrom
SimonWoolf wants to merge 2 commits intomainfrom
Conversation
…thing we tell people about It doesn't make sense to start out by saying "rewind can _also_ be set by..." and then giving the MQTT/SSE fallback method when we haven't told people the actual, real method yet. Nor to have that as a top-level paragraph followed by an inset note explaining when you should use that method, it's absolutely not intuitive that the inset note is meant to qualify the previous not-inset paragraph
channel options: https://ably.com/docs/api/realtime-sdk/types#channel-options channel params: possible values for the channelOptions.params map
|
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
It doesn't make any sense to start out by saying "rewind can also be set by..." and then the MQTT/SSE fallback method when we haven't told anyone the actual, main method that they should use with ably SDKs yet. Nor to have that as a top-level paragraph followed by an inset note explaining when you should use that method (for mqtt and sse), it's not at all obvious that the inset note is meant to tell you when to use the previous not-inset paragraph
I think this was a regression from #1937
also fix a bunch of places on that page where we call it a channel option not a channel param