fix typo

[datelier]

Description

SSIA

Related Issue

Versions

• Go Version: 1.22.3
• Rust Version: 1.77.2
• Docker Version: 20.10.8
• Kubernetes Version: v1.30.0
• NGT Version: 2.2.1

Checklist

• I have read the CONTRIBUTING document and completed our CLA agreement.
• I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

Summary by CodeRabbit

• Documentation
  • Updated heading levels for better readability in the API documentation.
    • Changed ## Input to ### Input in remove.md.
    • Changed ### MultiSearchByID RPC to ## MultiSearchByID RPC in search.md.
    • Changed ### MultiLinearSearchByID RPC to ## MultiLinearSearchByID RPC in search.md.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates involve modifying the section headings in the API documentation files. Specifically, the heading levels for input sections and RPC methods were adjusted to ensure consistency and clarity. This includes changing a heading from ## to ### in remove.md and vice versa for two RPC methods in search.md.

Changes

Files	Change Summary
docs/api/remove.md	Altered the section heading from ## Input to ### Input
docs/api/search.md	Adjusted headings for MultiSearchByID RPC and MultiLinearSearchByID RPC from ### to ##

---

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
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[vdaas-ci]

[CHATOPS:HELP] ChatOps commands.

• 🙆‍♀️ /approve - approve
• 🍱 /format - format codes and add licenses
• ✅ /gen-test - generate test codes
• 🏷️ /label - add labels
• 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

[hlts2]

LGTM!

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (3)

docs/api/remove.md (3)

Line range hint 245-245: Consider rephrasing to avoid repetition and enhance readability.

- It's the recommended method to remove a large number of vectors.
+ It's the preferred method for removing numerous vectors.

---

Line range hint 446-446: Consider rephrasing to avoid repetition and enhance readability.

- The list of `Object.Location`.
+ The collection of `Object.Location` instances.

---

Line range hint 205-205: Consider rephrasing to avoid repetition and enhance readability.

- The list of `Object.Location`.
+ The collection of `Object.Location` instances.

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a1ed3ff and 5f41e68.

Files selected for processing (2)

• docs/api/remove.md (1 hunks)
• docs/api/search.md (2 hunks)

Files skipped from review due to trivial changes (1)

• docs/api/search.md

Additional Context Used

LanguageTool (3)

docs/api/remove.md (3)

Near line 205: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location | field |...

---

Near line 245: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: .... It's the recommended method to remove a large number of vectors. ### Input - the scheme of `p...

---

Near line 446: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location | field |...

Additional comments not posted (2)

docs/api/remove.md (2)

Line range hint 14-19: LGTM! The description of the Remove RPC method is clear and well-structured.

---

372-372: LGTM! The description of the RemoveByTimestamp RPC method is clear and well-structured.