Skip to content
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

Refactor message docs for deletions. #402

Merged
merged 1 commit into from
Dec 9, 2024
Merged

Conversation

splindsay-92
Copy link
Contributor

Refactored the deletion aspect of chat in the README.md, so it keeps consistency with updates and provides greater clarity for its usage.

@splindsay-92 splindsay-92 requested a review from a team November 14, 2024 16:18
Copy link

coderabbitai bot commented Nov 14, 2024

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.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot temporarily deployed to staging/pull/402/typedoc November 14, 2024 16:19 Inactive
Copy link

github-actions bot commented Nov 14, 2024

Coverage Report

Status Category Percentage Covered / Total
🟢 Lines 93.9% (🎯 92%) 3297 / 3511
🟢 Statements 93.9% (🎯 92%) 3297 / 3511
🟢 Functions 96.15% (🎯 92%) 250 / 260
🟢 Branches 94.41% (🎯 93%) 846 / 896
File CoverageNo changed files found.
Generated in workflow #1853 for commit 7e1df86 by the Vitest Coverage Report Action

Deletion messages received from realtime have the `latestAction` parameter set to `ChatMessageActions.MessageDelete`, and the event received has the `type` set to `MessageEvents.Deleted`.
Just like `updates`, `deletion` messages are also full copies of the message, meaning that all that is needed to keep a state or UI up to date is to replace the old message with the received one.

On rare occasions, deletes and updates might arrive over realtime out of order.
Copy link
Collaborator

Choose a reason for hiding this comment

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

As we provide order guarantees, I think its important to clarify here what "out of order" means. What you mean to say, I think, is that the order messages are received in realtime does not necessarily reflect the global ordering of events (e.g. due to concurrent operations in multiple regions)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated the comment here to detail this and also recommend that users should always use the actionBefore etc.. for ordering actions.

@splindsay-92 splindsay-92 force-pushed the refactor/update-delete-docs branch from 10c992e to 5f5abef Compare December 2, 2024 11:48
@github-actions github-actions bot temporarily deployed to staging/pull/402/typedoc December 2, 2024 11:49 Inactive
@splindsay-92 splindsay-92 force-pushed the refactor/update-delete-docs branch from 5f5abef to 2937d3f Compare December 2, 2024 12:04
@splindsay-92 splindsay-92 requested a review from AndyTWF December 2, 2024 12:05
@github-actions github-actions bot temporarily deployed to staging/pull/402/typedoc December 2, 2024 12:05 Inactive
@splindsay-92 splindsay-92 force-pushed the refactor/update-delete-docs branch from 2937d3f to c20c878 Compare December 5, 2024 10:00
@github-actions github-actions bot temporarily deployed to staging/pull/402/typedoc December 5, 2024 10:01 Inactive
- Refactored the deletion aspect of chat in the README.md, so it keeps consistency with updates and provides greater clarity for its usage.
@AndyTWF AndyTWF force-pushed the refactor/update-delete-docs branch from c20c878 to 7e1df86 Compare December 9, 2024 10:55
@AndyTWF AndyTWF enabled auto-merge December 9, 2024 10:55
@AndyTWF AndyTWF merged commit bfdbcfd into main Dec 9, 2024
9 checks passed
@AndyTWF AndyTWF deleted the refactor/update-delete-docs branch December 9, 2024 10:58
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.

2 participants