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

Docs: Change rule descriptions for consistent casing #6915

Merged
merged 1 commit into from Aug 16, 2016

Conversation

btmills
Copy link
Member

@btmills btmills commented Aug 16, 2016

What issue does this pull request address?

Scrolling through http://eslint.org/docs/rules, I found two descriptions that began with uppercase letters, while all the rest were lowercase.

What changes did you make? (Give an overview)

I changed the two inconsistent descriptions to begin with lowercase letters.

Is there anything you'd like reviewers to focus on?

For the curious, here's how I ran a quick check to be sure I didn't miss any:

Array.from(document.querySelectorAll('tr td:last-child p'))
    .map(p => p.innerText)
    .filter(description =>
        description[0].toLowerCase() !== description[0]
    )

Scrolling through eslint.org/docs/rules, I found two descriptions that
began with uppercase letters, while all the rest were lowercase. For the
curious, here's how I ran a quick check to be sure I didn't miss any:

```js
Array.from(document.querySelectorAll('tr td:last-child p'))
    .map(p => p.innerText)
    .filter(description =>
        description[0].toLowerCase() !== description[0]
    )
```
@mention-bot
Copy link

@btmills, thanks for your PR! By analyzing the annotation information on this pull request, we identified @gyandeeps, @jfmengels and @kaicataldo to be potential reviewers

@eslintbot
Copy link

LGTM

@ilyavolodin
Copy link
Member

LGTM. We should think about adding a custom rule for this.

@ilyavolodin ilyavolodin merged commit d8b770c into master Aug 16, 2016
@btmills btmills deleted the docs-rule-description-casing branch August 16, 2016 13:38
@vitorbal
Copy link
Member

@ilyavolodin sounds good, maybe the custom rule could also enforce that the description starts with one of "enforce", "require", "disallow", etc.?
When we make it so the title of each rule page also comes from the meta.description we will benefit even more from this consistency.

@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants