Add disableOnNumbers to typo tolerance settings

[nnethercott]

Pull Request

Allow disabling of typo tolerance for numbers in meilisearch 1.15

Related issue

Fixes #1114

What does this PR do?

• Adds disable_on_numbers to TypoTolerance class
• Adds tests to ensure the setting updates meilisearch as expected

PR checklist

Please check if your PR fulfills the following requirements:

• Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

• New Features

  • Added a new option to typo tolerance settings that allows disabling typo tolerance on numbers.

• Tests

  • Introduced a test to verify the behavior of the new setting for disabling typo tolerance on numbers.

[coderabbitai]

Walkthrough

A new boolean field disable_on_numbers was added to the TypoTolerance class in the Meilisearch index model, defaulting to False. Corresponding test cases were updated and expanded to verify the correct handling of this field, including a new test for enabling the setting. A new code sample demonstrating this setting was also added.

Changes

File(s)	Change Summary
meilisearch/models/index.py	Added disable_on_numbers: bool = False to TypoTolerance class.
tests/settings/test_settings_typo_tolerance_meilisearch.py	Updated test dictionaries to include "disableOnNumbers". Added test for setting it to True.
.code-samples.meilisearch.yaml	Added new snippet typo_tolerance_guide_5 demonstrating disableOnNumbers usage.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite
    participant Index
    participant SettingsAPI

    TestSuite->>Index: update_typo_tolerance({disableOnNumbers: True})
    Index->>SettingsAPI: Send update request
    SettingsAPI-->>Index: Confirm update (task status)
    TestSuite->>Index: get_typo_tolerance()
    Index->>SettingsAPI: Fetch typo tolerance settings
    SettingsAPI-->>Index: Return settings (disable_on_numbers: True)
    TestSuite->>TestSuite: Assert disable_on_numbers is True

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Update the settings API to handle disableOnNumbers for typo tolerance (#1114)	✅
Add new test cases (#1114)	✅
Add a code sample under the typo_tolerance_guide_5 key in .code-samples.meilisearch.yaml (#1114)	✅

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
None detected

Possibly related issues

• [v1.15] Add disableOnNumbers to typo tolerance settings meilisearch-rust#670: This PR implements the addition of disable_on_numbers to the TypoTolerance class, matching the feature described in this issue.

Poem

In fields of code where numbers hop,
A rabbit tweaks the typo crop—
Now numbers stand, typos denied,
With tests to keep them verified.
The garden grows, the settings bloom,
Bugs and errors find no room!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5f2698d and 7edc3e4.

📒 Files selected for processing (1)

• .code-samples.meilisearch.yaml (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .code-samples.meilisearch.yaml

---

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

• 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[Strift]

Hi @nnethercott, and thanks for your contribution!

This is all good except for the code sample.

Can you please add an example under the typo_tolerance_guide_5 key in .code-samples.meilisearch.yaml?

Then we'll be ready to merge 🙏