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

Add entry for Vale rule: allow.yml #436

Open
daobrien opened this issue Nov 12, 2022 · 2 comments
Open

Add entry for Vale rule: allow.yml #436

daobrien opened this issue Nov 12, 2022 · 2 comments
Assignees
Labels
enhancement Will improve the guide but is not a bug or blocker. P2 Should address this soon.
Projects

Comments

@daobrien
Copy link
Collaborator

When we create rules in Vale we need to make sure that they're based on solid
guidance, and that we can refer writers to this guidance for more info.

allow.yml tests for "allows" and "permits" and suggests using "enables" or
similar instead. Other options are available of course, such as supports,
provides, lets, facilitates, etc. This is too much info for the Vale message,
but we should include it in the style guide.

Ideally, we should also ensure that these entries have IDs so that we can link
directly to them in Vale rules and also in editor snippet entries.

@daobrien daobrien added P2 Should address this soon. enhancement Will improve the guide but is not a bug or blocker. labels Nov 12, 2022
@julian-cable
Copy link
Collaborator

This item is covered in the "Anthropomorphism" section:
https://stylepedia.net/style/5.1/#Avoiding_Slang_Metaphors-MisleadingLanguage-Anthropomorphism

Rather than replacing "allow" or "permit" with a different verb, I usually find that a better approach is to rewrite the sentence to make the user the subject. So I would not see this one as a case of replacing verb 'a' with verb 'b'.

@daobrien
Copy link
Collaborator Author

daobrien commented Dec 2, 2022

The user is not necessarily the subject. If you set 664 perms on a file then those perms allow the user and group to write to that file. The permissions are doing the allowing, not the user. The "user" might not be a person, either. It might be a service or some other agent. There are many examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Will improve the guide but is not a bug or blocker. P2 Should address this soon.
Projects
No open projects
6.1
Awaiting triage
Development

No branches or pull requests

2 participants