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

[en] improve rules #11191

Merged
merged 1 commit into from
Jan 15, 2025
Merged

[en] improve rules #11191

merged 1 commit into from
Jan 15, 2025

Conversation

tiff
Copy link
Member

@tiff tiff commented Jan 15, 2025

Summary by CodeRabbit

Release Notes

  • New Features

    • Expanded spell checker dictionary with new words across various domains
    • Enhanced grammar rule matching for more precise language detection
  • Improvements

    • Updated grammar rules to improve detection of incorrect collocations
    • Refined token matching for more flexible language analysis
  • Bug Fixes

    • Improved pattern matching for specific grammatical constructions

Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Walkthrough

This pull request introduces modifications to LanguageTool's English language modules. The changes involve expanding the spell-checking vocabulary by adding new words to the spelling.txt file and refining grammar rules in the grammar.xml file. The spell-checker additions include scientific, cultural, and specialized terminology, while the grammar rule updates focus on enhancing pattern matching and antipattern detection for more precise language analysis.

Changes

File Change Summary
languagetool-language-modules/en/src/main/resources/org/languagetool/resource/en/hunspell/spelling.txt Added new words like "meromorphic" to expand spell-checker vocabulary
languagetool-language-modules/en/src/main/resources/org/languagetool/rules/en/grammar.xml - Added antipatterns for "AT_THE_JOB" and "ANALYSIS_ABOUT" rules
- Updated antipattern for "SPEND_IT_FOR" rule
- Modified token matching patterns for various rules

Possibly related PRs

Suggested reviewers

  • jaumeortola

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
languagetool-language-modules/en/src/main/resources/org/languagetool/resource/en/hunspell/spelling.txt (2)

Line range hint 656-667: Consider grouping related terms together.

For better maintainability, consider grouping related terms together in the file:

  1. Anatomical terms: "tympanic", "tympanum", "tympanums", "tympana"
  2. Religious terms: "Ebionite", "Ebionites", "Ebionism", "docetic", "docetism"
  3. Mathematical terms: "meromorphic"
  4. Brand names: "VisionTek"

Line range hint 656-667: Consider adding related mathematical terms.

For completeness, consider adding related mathematical terms:

  • "holomorphic" (related to meromorphic functions)
  • "analytic" (in the complex analysis context)
languagetool-language-modules/en/src/main/resources/org/languagetool/rules/en/grammar.xml (1)

106873-106873: Consider tightening the chunk_re pattern for better precision.

While the changes to SPEND_IT_FOR are good:

  • Extended antipattern for reflexive pronouns is comprehensive
  • However, the chunk_re=".-VP" pattern is too loose and might match unintended verb phrases

Consider using a more specific pattern like chunk_re="B-VP.*" to ensure "spend" starts a verb phrase.

Also applies to: 106877-106877

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2d8ffec and e3abb81.

📒 Files selected for processing (2)
  • languagetool-language-modules/en/src/main/resources/org/languagetool/resource/en/hunspell/spelling.txt (1 hunks)
  • languagetool-language-modules/en/src/main/resources/org/languagetool/rules/en/grammar.xml (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (java-kotlin)
🔇 Additional comments (8)
languagetool-language-modules/en/src/main/resources/org/languagetool/resource/en/hunspell/spelling.txt (5)

656-656: LGTM! Mathematical term correctly added.

The term "meromorphic" is a valid mathematical term related to complex analysis and function theory.


Line range hint 657-660: LGTM! Anatomical terms are complete and well-formed.

The anatomical terms "tympanic", "tympanum", "tympanums", and "tympana" form a complete set with both singular and plural forms (including the Latin plural "tympana").


Line range hint 662-664: LGTM! Religious terms are complete and well-formed.

The terms "Ebionite", "Ebionites", and "Ebionism" form a complete set covering both the adherents and the belief system.


Line range hint 665-666: LGTM! Religious terms are properly added.

The terms "docetic" and "docetism" are correctly added, representing both the adjective and the noun forms of this theological concept.


Line range hint 661-661: Verify brand name capitalization.

Please verify that "VisionTek" follows the company's official capitalization style.

✅ Verification successful

Brand name "VisionTek" appears to be correctly capitalized

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check official brand name capitalization
# Search for any variations of the brand name in documentation or official sources
rg -i "visiontek|vision-?tek" 

Length of output: 259


Script:

#!/bin/bash
# Search for any documentation files containing the brand name
fd -e md -e txt -e html README -x rg -i "visiontek|vision-?tek" {}

Length of output: 70

languagetool-language-modules/en/src/main/resources/org/languagetool/rules/en/grammar.xml (3)

106817-106824: Well-structured improvements to the AT_THE_JOB rule!

The changes enhance the rule's precision by:

  • Adding valid antipatterns for "shot at" and "remain/stay at"
  • Using chunk_re for better noun phrase detection
  • Including comprehensive examples that validate the changes

Also applies to: 106828-106828, 106834-106835


106839-106842: Good addition of the "what about" antipattern!

The antipattern effectively prevents false positives for valid question constructions while maintaining the rule's ability to catch incorrect "analysis about" usage.


106914-106914: Verify the impact of removing contraction support.

Removing regexp='yes' and the 'm' option from the token pattern might cause the rule to miss contractions like "I'm", "you're", etc.

Run this script to check for potential impact:

@tiff tiff merged commit fd0b8d0 into master Jan 15, 2025
5 checks passed
@tiff tiff deleted the cb-changes-20250115-2 branch January 15, 2025 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant