Skip to content

Conversation

@rahul-lohra
Copy link
Contributor

@rahul-lohra rahul-lohra commented Jan 16, 2026

Goal

Update kdoc for notifications

Implementation

Kdoc changes

🎨 UI Changes

None

Testing

Not required

Summary by CodeRabbit

  • Documentation
    • Updated deprecation notice with clearer migration guidance for notification handling.
    • Expanded documentation with comprehensive examples demonstrating recommended notification handling patterns and related functionality.

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

@rahul-lohra rahul-lohra self-assigned this Jan 16, 2026
@rahul-lohra rahul-lohra requested a review from a team as a code owner January 16, 2026 07:00
@rahul-lohra rahul-lohra added the pr:documentation Changes to documentation only label Jan 16, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 16, 2026

PR checklist ✅

All required conditions are satisfied:

  • Title length is OK (or ignored by label).
  • At least one pr: label exists.
  • Sections ### Goal, ### Implementation, and ### Testing are filled.

🎉 Great job! This PR is ready for review.

@rahul-lohra rahul-lohra changed the base branch from develop to develop-v2 January 16, 2026 07:00
@coderabbitai
Copy link

coderabbitai bot commented Jan 16, 2026

Walkthrough

Updated the deprecation message in DefaultNotificationHandler to direct developers to CompatibilityStreamNotificationHandler instead of generic notification interceptors. Expanded the KDoc documentation in CompatibilityStreamNotificationHandler with detailed usage examples and references to related interceptor types.

Changes

Cohort / File(s) Summary
Deprecation Message Update
stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/notifications/DefaultNotificationHandler.kt
Updated @Deprecated annotation message to reference CompatibilityStreamNotificationHandler as the recommended replacement instead of generic notification interceptors.
Documentation Expansion
stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/notifications/handlers/CompatibilityStreamNotificationHandler.kt
Expanded KDoc block with comprehensive documentation describing class purpose, usage examples demonstrating interceptors for notification building and updating, and references to related interceptor types. No logic or code behavior changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A deprecated path now points the way,
To CompatibilityHandler bright as day,
With docs expanded, examples clear,
The developer's path is crystal near!
No logic bent, just words improved,
The notification way is now approved! 📝✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The description is largely incomplete. While it follows the template structure, the Goal and Implementation sections lack meaningful detail, and most required checklist items are unchecked. Expand the Goal section to explain why KDoc updates were necessary. Provide specific details in Implementation about which KDocs were updated and why. Complete the contributor checklist items appropriately.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title 'Update kdoc for notifications api' directly describes the main change—expanding and updating KDoc documentation for the notifications API. It accurately summarizes the primary purpose of the changeset.

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

✨ Finishing touches
  • 📝 Generate docstrings

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.

@github-actions
Copy link
Contributor

SDK Size Comparison 📏

SDK Before After Difference Status
stream-video-android-core 11.94 MB 11.94 MB 0.00 MB 🟢
stream-video-android-ui-xml 5.68 MB 5.68 MB 0.00 MB 🟢
stream-video-android-ui-compose 6.28 MB 6.28 MB 0.00 MB 🟢

@sonarqubecloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
60.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud

@rahul-lohra rahul-lohra changed the title Update kdoc for notifications Update kdoc for notifications api Jan 16, 2026
@rahul-lohra rahul-lohra changed the title Update kdoc for notifications api [AND-1021] Update kdoc for notifications api Jan 16, 2026
@rahul-lohra rahul-lohra changed the title [AND-1021] Update kdoc for notifications api Update kdoc for notifications api Jan 16, 2026
@aleksandar-apostolov aleksandar-apostolov merged commit 68c1a8c into develop-v2 Jan 16, 2026
13 of 18 checks passed
@aleksandar-apostolov aleksandar-apostolov deleted the docs/rahullohra/notifications branch January 16, 2026 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr:documentation Changes to documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants