fix copied comments

[cortfritz]

It looks like the comments for Yex.apply_update were copied. Update replaces the copied text that was specific to the original comment with correct explanation.

Optionally, could just delete the copied text, happy to submit that PR instead.

Summary by CodeRabbit

• Documentation Updates

  • Enhanced clarity and consistency in documentation across multiple modules.
  • Updated examples for functions to better illustrate their usage.
  • Changed documentation headings for better accuracy (e.g., "Example" to "Examples").
  • Added detailed descriptions for parameters and return values in several callback functions.

• Deprecations

  • Marked get/2 function as deprecated in both Yex.Array and Yex.Map, redirecting users to fetch/2.

• New Features

  • Introduced fetch!/2 function in Yex.Map for improved error handling.

[coderabbitai[bot]]

Walkthrough

The pull request introduces several documentation enhancements across multiple modules in the Yex library, including Yex.DocServer, Yex.Array, Yex.Map, Yex.Text, and Yex. Key changes include the deprecation of the get/2 function in both Yex.Array and Yex.Map, replaced by fetch/2, and improved clarity in function documentation, particularly for callbacks and error handling. The overall functionality and signatures of the functions remain unchanged, focusing on enhancing documentation clarity and consistency.

Changes

File Path	Change Summary
lib/server/doc_server.ex	- Updated @moduledoc from "Example" to "Examples". - Enhanced @doc for handle_update_v1, handle_awareness_change, and init with detailed descriptions.
lib/shared_type/array.ex	- Deprecated get/2, redirecting to fetch/2. - Enhanced documentation for fetch/2, insert_list/3, to_list/1, length/1, and to_json/1 with new examples.
lib/shared_type/map.ex	- Deprecated get/2, introduced fetch!/2. - Updated documentation for fetch/2 and to_json/1 with clearer examples.
lib/shared_type/text.ex	- Updated documentation for to_delta and from functions to clarify examples.
lib/y_ex.ex	- Updated documentation for apply_update for consistency. - Refined error handling in encode_state_as_update! to raise specific ArgumentError.

Possibly related PRs

• #90: Updates to the Yex.DocServer module that enhance its functionality, related to the changes in this PR.
• #92: Refactors the Yex.Sync.SharedDoc module to utilize Yex.DocServer, indicating a direct relationship with the modifications in the document server's handling.

🐇 In the land of code, where rabbits play,
Documentation blooms, brightening the way.
Functions deprecated, new paths we find,
Clarity reigns, leaving confusion behind.
With each little change, our code's a delight,
Hopping along, making everything right! 🌟

---

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[coveralls]

coverage: 94.462% (-0.3%) from 94.769% when pulling bed79e0b9a3092a49ce40f2ac53dcc94f8a6a288 on cortfritz:main into 0f04814d01f84870a69ac6b78d8e24b14d816a97 on satoren:main.