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

Markdown files should have their negative counter examples bold annotated #1503

Closed
felicio opened this issue Oct 27, 2017 · 2 comments
Closed

Comments

@felicio
Copy link
Contributor

felicio commented Oct 27, 2017

To continue where the conversation on pull request #1467 thread left off, I'd like to propose two interventions to the style of files documenting individual rules.

  1. Word negating sentence of a counter code example should be bold to increase overall orientation in text.
  2. Newly created files should follow this rule.

I'm willing to make the change in current files. However, I have a couple of questions:

  • In bold should only be the adverb (i.e. not) or a verb too (e.g. are not)?
  • Where in a style guide should be made a record of this rule?
@felicio
Copy link
Contributor Author

felicio commented Oct 27, 2017

/cc @ljharb

@ljharb
Copy link
Member

ljharb commented Oct 27, 2017

Let's start just bolding the adverb, and let's add the instructions to a CONTRIBUTING.md?

felicio added a commit to felicio/eslint-plugin-react that referenced this issue Oct 27, 2017
Increase legibility of negative sentences in counter examples.

Closes jsx-eslint#1503
felicio added a commit to felicio/eslint-plugin-react that referenced this issue Oct 27, 2017
Increase legibility of negative sentences in counter examples.

Closes jsx-eslint#1503
@ljharb ljharb closed this as completed in 41d9809 Oct 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants