Skip to content

Conversation

@sacOO7
Copy link
Contributor

@sacOO7 sacOO7 commented Jan 15, 2026

Summary by CodeRabbit

  • Documentation
    • Updated Swift SDK documentation examples with revised parameter labels for message operations (send, update, delete) and room creation, improving API consistency and clarity for developers.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 15, 2026

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Documentation files are updated to reflect Swift API method signature changes, replacing parameter labels params with withParams, forSerial with withSerial, and enter with enableEvents in code examples across getting-started and API reference pages.

Changes

Cohort / File(s) Summary
Swift API Parameter Label Updates
src/pages/docs/chat/getting-started/swift.mdx, src/pages/docs/chat/rooms/messages.mdx
Updated send() method calls: params:withParams:; Updated update() method calls: forSerial:withSerial:; Updated delete() method calls: forSerial:withSerial: and params:details:
Room Configuration Documentation
src/pages/docs/chat/rooms/index.mdx
Changed PresenceOptions parameter from enter: false to enableEvents: false in room creation example

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Parameter labels hop and dance,
withParams takes the lead,
forSerial becomes withSerial's stance,
These docs now plant the seed! 🌱

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Fix chat-swift doc snippets' directly and clearly summarizes the main change: updating Swift chat documentation code examples with corrected API signatures.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sacOO7 sacOO7 changed the title Fixed chat-swift snippets with correct method/API signature Fixe chat-swift doc snippets Jan 15, 2026
@sacOO7 sacOO7 changed the title Fixe chat-swift doc snippets Fix chat-swift doc snippets Jan 15, 2026
@sacOO7 sacOO7 marked this pull request as ready for review January 15, 2026 06:42
@sacOO7
Copy link
Contributor Author

sacOO7 commented Jan 15, 2026

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Jan 15, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@sacOO7 sacOO7 requested review from maratal and umair-ably January 15, 2026 06:45
Copy link
Collaborator

@maratal maratal left a comment

Choose a reason for hiding this comment

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

LGTM

@sacOO7 sacOO7 force-pushed the fix/missing-chat-documentation branch from bef8be6 to a6181a1 Compare January 15, 2026 14:39
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.

4 participants