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

[pt-PT] Removed temp_off from subrule in rule ID:INFORMALITIES #10914

Merged
merged 1 commit into from
Oct 4, 2024

Conversation

marcoagpinto
Copy link
Member

@marcoagpinto marcoagpinto commented Oct 4, 2024

Just removed “temp_off”

Summary by CodeRabbit

  • New Features
    • Introduced several new style rules for Portuguese, enhancing clarity and formality.
      • New rules include discouraging gerund usage and recommending more formal expressions.
  • Rule Modifications
    • Updated existing rules for improved clarity and specificity, ensuring better language guidance.
  • Bug Fixes
    • Temporarily deactivated certain rules for ongoing evaluation of their effectiveness.
  • Suggestions
    • Added antipatterns to prevent common stylistic errors, promoting a more formal tone in writing.

Copy link
Contributor

coderabbitai bot commented Oct 4, 2024

Walkthrough

The pull request introduces significant updates to the style.xml file for Portuguese language rules in LanguageTool. It includes the addition of new style rules, modifications to existing rules for improved clarity, and the temporary deactivation of certain rules. The changes aim to enhance the overall quality of Portuguese text by addressing common stylistic issues and formalizing language usage. The XML structure has been preserved while the content within various tags has been extensively revised.

Changes

Files Change Summary
languagetool-language-modules/pt/src/main/resources/org/languagetool/rules/pt/style.xml - Added new rules: AVOID_GERUND_ALL, EM_DETALHE_DETALHADAMENTE_PT_PT, ENSINO_SUPERIOR, FAZER_DESPORTO.
- Modified existing rules: AVOID_GERUND, FORMAL_SPEECH_PT_PT, FORMAL_T-V_DISTINCTION.
- Some rules deactivated (default='temp_off').
- Added antipatterns and suggestions for stylistic improvements.

Possibly related PRs

Suggested reviewers

  • p-goulart
  • susanaboatto

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.

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

🧹 Outside diff range and nitpick comments (1)
languagetool-language-modules/pt/src/main/resources/org/languagetool/rules/pt/pt-PT/style.xml (1)

Line range hint 1-1885: File structure and organization suggestions

While the specific change requested in this pull request has been implemented correctly, I have some general observations about the file:

  1. The file is quite large and contains numerous rules and antipatterns. Consider splitting this file into smaller, more manageable files based on rule categories or types to improve maintainability.

  2. Many rules use hardcoded lists of words or expressions. Consider moving these lists to separate resource files or databases to make updates and maintenance easier.

  3. The file contains a mix of comments in English and Portuguese. For consistency and ease of international collaboration, consider using a single language (preferably English) for all comments and documentation.

  4. Some rules have extensive antipatterns. While these are necessary for accuracy, they can make the rules harder to read and maintain. Consider refactoring complex rules into multiple simpler rules where possible.

  5. The file uses a combination of XML attributes and child elements for defining rule properties. For consistency, consider standardizing on one approach throughout the file.

These suggestions are not directly related to the current pull request but could be considered for future improvements to enhance the overall maintainability and readability of the codebase.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 80b9a96 and eaaa949.

📒 Files selected for processing (1)
  • languagetool-language-modules/pt/src/main/resources/org/languagetool/rules/pt/pt-PT/style.xml (1 hunks)
🔇 Additional comments (1)
languagetool-language-modules/pt/src/main/resources/org/languagetool/rules/pt/pt-PT/style.xml (1)

Line range hint 1879-1885: Removal of temporary deactivation for a subrule

The temp_off attribute has been removed from the following subrule:

<rule>
    <pattern>
        <token inflected='yes'>dar</token>
        <token>uma</token>
        <token>volta</token>
        <token>ao</token>
        <token>bilhar</token>
        <token>grande</token>
    </pattern>
    <message>&colloquialism_msg;</message>
    <short>Coloquialismo</short>
    <example correction=''>Vai <marker>dar uma volta ao bilhar grande</marker>.</example>
</rule>

This change indicates that the rule is now active and will flag the colloquial expression "dar uma volta ao bilhar grande" as informal language. This is consistent with the purpose of the INFORMALITIES rule group, which aims to identify and suggest alternatives for informal language usage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant