Skip to content

Add Vale to RTD pre-commit #273

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add Vale to RTD pre-commit #273

wants to merge 7 commits into from

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Jun 19, 2025

@ericholscher ericholscher requested a review from a team as a code owner June 19, 2025 08:57
@ericholscher ericholscher requested a review from stsewd June 19, 2025 08:57
Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

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

Looks good 👍🏼

@ericholscher
Copy link
Member Author

I moved the common vale files over here, and symlinked them into org/business

@ericholscher
Copy link
Member Author

The original changes were described here: readthedocs/readthedocs.org#12258

Copy link
Contributor

Choose a reason for hiding this comment

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

I updated this file in a PR, so we should reflect that here. But note that the filename is incorrect, it needs to be .yml for vale to find it.

@@ -0,0 +1,9 @@
extends: substitution
message: Use 'Single sign-on' instead of '%s'
Copy link
Contributor

Choose a reason for hiding this comment

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

Also note the message double substitution is important. Very silly this isn't just a default for the message attr.

Suggested change
message: Use 'Single sign-on' instead of '%s'
message: Use '%s' instead of '%s'

Single Sign on: Single sign-on
single sign-on: Single sign-on
single Sign-On: Single sign-on
single Sign on: Single sign-on
Copy link
Contributor

Choose a reason for hiding this comment

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

And this is substituting a capitalized version still. I fixed this using case insensitivity and exceptions:

readthedocs/readthedocs.org#12260

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.

3 participants