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

PR to adjust Vale settings #279

Open
wants to merge 1 commit into
base: website
Choose a base branch
from
Open

PR to adjust Vale settings #279

wants to merge 1 commit into from

Conversation

bbrennanbasis
Copy link
Contributor

This PR is to reduce the amount of errors that show up whenever an article includes sample code or method names.

@hyyan
Copy link
Member

hyyan commented Oct 17, 2024

@bbrennanbasis Could you please clarify why you want to disable these rules? These rules should be evaluated on a per-PR basis to determine if the warnings are relevant. Vale doesn't inspect code snippets, so the rules don't apply there. For method names wrapped in backticks, Vale ignores them and understands that semicolons or parentheses are intentional.

@bbrennanbasis
Copy link
Contributor Author

@hyyan I had incorrectly pointed out which specific examples cause Vale to give errors. While it does not do it in sample code or method names, it still gives errors when doing import statements or whenever a defined attribute uses parentheses.

For example, take PR #209. Vale gave four errors for each of the import statements that used semicolons, and two errors for the TableBuilder tag that used parentheses. To put it into perspective, there are only ten errors from Vale for this PR.

Semicolons rarely appear in the actual writing of the articles, but they will always appear in the import statements. This is why I feel that the Vale errors for semicolons are doing more harm than good, as this will be a continuous error reviewers have to dismiss every time someone opens a PR.

@hyyan
Copy link
Member

hyyan commented Oct 18, 2024

@bbrennanbasis Thanks. All important statements should be added to the MDXComponents file. We also have an issue related to the TableBuilder and the parentheses here. These two rules should remain unless there are valid reasons for keeping them enabled.

@hyyan hyyan closed this Oct 18, 2024
@hyyan hyyan reopened this Jan 14, 2025
@hyyan hyyan requested review from nmlynx and mschned as code owners January 14, 2025 13:11
@hyyan
Copy link
Member

hyyan commented Jan 14, 2025

Hi @bbrennanbasis, we’re going to take a look at this again. Could you also turn off the ‘Latin’ rule so we can merge this PR? Thanks!

- `Latin`
- `Parens`
- `Semicolons`
@bbrennanbasis
Copy link
Contributor Author

@hyyan Rebased and turned off the Latin rule.

Copy link
Member

@MatthewHawkins MatthewHawkins left a comment

Choose a reason for hiding this comment

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

Super, ty Ben!

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

Successfully merging this pull request may close these issues.

3 participants