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] Added rule ID:PARA_NADA_DESNECESSARIAMENTE #10904

Merged
merged 1 commit into from
Oct 1, 2024

Conversation

marcoagpinto
Copy link
Member

@marcoagpinto marcoagpinto commented Sep 29, 2024

Heya, @susanaboatto and @p-goulart ,

Here is a brand-new rule.

This and the next one must be ready already for a week or so, but I have been waiting for the official release of LanguageTool to start creating pull requests again without the pressure of feature freeze time.

Summary by CodeRabbit

  • New Features
    • Introduced a new rule for the Portuguese language module that suggests replacing "para nada" with "desnecessariamente" in formal contexts.
    • Enhanced formal language style checking with specific examples and correction messages.

Copy link
Contributor

coderabbitai bot commented Sep 29, 2024

Walkthrough

A new rule has been added to the Portuguese language module of LanguageTool, specifically in the style.xml file. This rule, named PARA_NADA_DESNECESSARIAMENTE, targets the phrase "para nada" in formal contexts, recommending its replacement with "desnecessariamente." The rule includes patterns for matching specific verbs followed by "para nada" and provides correction messages along with examples.

Changes

File Path Change Summary
languagetool-language-modules/pt/src/main/resources/org/languagetool/rules/pt/style.xml Added a new rule PARA_NADA_DESNECESSARIAMENTE to address the usage of "para nada" in formal contexts.

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 (2)
languagetool-language-modules/pt/src/main/resources/org/languagetool/rules/pt/style.xml (2)

3622-3630: Pattern matching logic is comprehensive and flexible.

The rule's pattern effectively captures a wide range of scenarios where "para nada" might be used inappropriately in formal contexts. The extensive verb list and flexible matching for articles, numerals, and nouns demonstrate a thorough approach.

Consider breaking down the long list of verbs into smaller, semantically grouped lists for easier maintenance. This could be achieved using entity references in XML. For example:

<!ENTITY action_verbs "adjudicar|administrar|afligir|aguardar|ajudar|...">
<!ENTITY cognitive_verbs "analisar|antecipar|avaliar|considerar|...">
<!-- More verb categories -->

<token regexp='yes' inflected='yes'>&action_verbs;|&cognitive_verbs;|...</token>

This approach would make the rule more maintainable and easier to update in the future.


3631-3634: Message and examples are clear and effective.

The suggestion message and examples effectively demonstrate the rule's purpose and application. They provide clear guidance for users on how to improve their formal language usage.

Consider adding a brief explanation of why "desnecessariamente" is preferred in formal contexts. This could enhance the educational value of the rule. For example:

<message>Num contexto formal, empregue <suggestion>desnecessariamente</suggestion> em vez de "para nada". Esta substituição torna a frase mais concisa e adequada ao tom formal.</message>

This addition would provide users with a better understanding of the reasoning behind the suggestion.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between d5b9008 and 5f7dd6a.

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

3620-3621: LGTM: Rule definition and attributes are well-structured.

The rule definition follows the established conventions and includes appropriate attributes. The use of 'temp_off' as the default setting is a good practice for new rules.


3620-3634: Overall, excellent addition to the Portuguese language module.

This new rule, PARA_NADA_DESNECESSARIAMENTE, is a valuable addition to the LanguageTool project's Portuguese module. It effectively addresses the use of "para nada" in formal contexts, suggesting the more appropriate "desnecessariamente". The implementation is thorough, with a comprehensive verb list and flexible pattern matching.

A few minor suggestions have been made to potentially improve maintainability and user understanding, but these are not critical for the functionality of the rule.

This contribution aligns well with the PR objectives, enhancing the formal language style checking capabilities of LanguageTool for Portuguese. Great work, @marcoagpinto!

@susanaboatto
Copy link
Collaborator

I think this rule is mostly applicable to pt-PT. The word use/structuring here is not really common in pt-BR. I suggest moving the rule to the pt-PT grammar to avoid complications.

@susanaboatto
Copy link
Collaborator

I will approve this so we can check the diff though. Pull another request before you remove the temp_off, and we'll see if this is dialect-biased :)

@marcoagpinto
Copy link
Member Author

I will approve this so we can check the diff though. Pull another request before you remove the temp_off, and we'll see if this is dialect-biased :)

Sure, Susana, thanks!

So much to do and so little time.

😛 😛 😛 😛 😛 😛 😛 😛 😛 😛 😛 😛 😛 😛 😛

@marcoagpinto marcoagpinto merged commit e0dcb81 into master Oct 1, 2024
5 checks passed
@marcoagpinto marcoagpinto deleted the lt_marcoagpinto_20240929_1623 branch October 1, 2024 11:58
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.

2 participants