-
Notifications
You must be signed in to change notification settings - Fork 0
docs: Disconnected event now carries a DisconnectReason #365
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
9439dc0
docs: Disconnected event now carries a DisconnectReason (whatsapp-rus…
claude e788e12
docs: document DisconnectReason::is_clean_shutdown()
claude 214baf7
docs: fix impl block syntax and table pipe escaping in transport.mdx
claude fd64032
docs: clarify Disconnected's Emitted wording (Greptile nit)
claude File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is_clean_shutdown()not documented in the linkedDisconnectReasonreferenceThe text directs users to call
reason.is_clean_shutdown(), then links them to/api/transport#disconnectedfor the variants. However,api/transport.mdxonly documents the four enum variants (ServerClose,StreamEnded,ReadError,Unknown) — there is no helper-methods section and no mention ofis_clean_shutdown()anywhere in the file. A developer following the link will find the variants but no explanation of which variant(s) the method considers a clean shutdown, or that the method exists at all. The helper should be documented inapi/transport.mdxalongside the enum definition.Prompt To Fix With AI