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

Filter for parenthesis use #56

Open
StraubCreative opened this issue Aug 9, 2024 · 0 comments
Open

Filter for parenthesis use #56

StraubCreative opened this issue Aug 9, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@StraubCreative
Copy link
Collaborator

Explain the feature or enhancement in detail
Overall it's an issue that keeps coming up: improper or over use of parenthesis.

The most egregious example I see is putting navigational instructions in parenthesis, when it's not part of an active instruction.

I'd ideally like to see very low/no parenthesis use in the documentation since it's often a proxy for unclear writing, and, unsurprisingly, it only adds noise to documentation instructions.

Can we create a warning for body content (excluding tags) when there is more than 2 or 3 instances of parenthesis pairs? Can also add an explicit rule that looks for :menuselection: inside of parenthesis.

Screenshots
N/A

Additional context
N/A

@StraubCreative StraubCreative added the enhancement New feature or request label Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants