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: Heading formatting inconsistencies #4912

Closed
alberto opened this Issue Jan 10, 2016 · 5 comments

Comments

Projects
None yet
5 participants
@alberto
Copy link
Member

alberto commented Jan 10, 2016

There are doc headings using many different formats. Here are some examples:

#### `allowKeywords` http://eslint.org/docs/rules/dot-notation#allowkeywords

#### `"after"` http://eslint.org/docs/rules/operator-linebreak#after

#### "always" http://eslint.org/docs/rules/arrow-body-style#always

#### always http://eslint.org/docs/rules/array-bracket-spacing#always

Should we unify them?

@eslintbot

This comment has been minimized.

Copy link

eslintbot commented Jan 10, 2016

@alberto Thanks for the issue! If you're reporting a bug, please be sure to include:

  1. The version of ESLint you are using (run eslint -v)
  2. What you did (the source code and ESLint configuration)
  3. The actual ESLint output complete with numbers
  4. What you expected to happen instead

Requesting a new rule? Please see Proposing a New Rule for instructions.

@nzakas

This comment has been minimized.

Copy link
Member

nzakas commented Jan 11, 2016

If you're volunteering, sure. :)

@alberto

This comment has been minimized.

Copy link
Member Author

alberto commented Jan 11, 2016

Which format would you prefer?

@nzakas

This comment has been minimized.

Copy link
Member

nzakas commented Jan 11, 2016

It depends. For string options like "always", I think it should be " always". For nonstring values, I'd just use backticks.

@alberto alberto added accepted and removed evaluating labels Jan 12, 2016

ilyavolodin added a commit that referenced this issue Jan 12, 2016

Merge pull request #4929 from eslint/issue4912
Docs: Formatting inconsistencies (fixes #4912)
@BYK

This comment has been minimized.

Copy link
Member

BYK commented Jan 13, 2016

Suggestion: use remark-lint and add a custom rule that catches/detects these

@eslint eslint bot locked and limited conversation to collaborators Feb 6, 2018

@eslint eslint bot added the archived due to age label Feb 6, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
You can’t perform that action at this time.