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: Distinguish examples in rules under Stylistic Issues part 5 #6291

Merged
merged 1 commit into from Jun 2, 2016

Conversation

scriptdaemon
Copy link
Contributor

Another straight-forward batch.

@pedrottimark Let me know if anything catches your eye.

@eslintbot
Copy link

LGTM

@mention-bot
Copy link

By analyzing the blame information on this pull request, we identified @alberto, @IanVS and @pedrottimark to be potential reviewers


var foo = 5;



var bar = 3;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, these lines at the end confused me when I first read about this rule.

@pedrottimark
Copy link
Member

@scriptdaemon Thank you so much for working steadily through the second half of rules!

@eslintbot
Copy link

LGTM

@scriptdaemon
Copy link
Contributor Author

@pedrottimark Everything (except one concern that we should discuss) has been addressed up until this point.


Nesting ternary expressions makes code unclear. The `no-nested-ternary` rule disallows the use of nested ternary expressions.
Nesting ternary expressions can makes code more difficult to understand.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/can makes/can make/

@pedrottimark
Copy link
Member

From the “View the whole file” step: 2 changes for grammatical agreement and 1 phrase deletion

@eslintbot
Copy link

LGTM

@scriptdaemon
Copy link
Contributor Author

@pedrottimark Done. Thanks for being patient with my numerous oversights. 😀

@pedrottimark
Copy link
Member

@scriptdaemon Thank you! It’s going well from my point of view 😀

Until we will write up a doc about docs, here is a principle to explain some of my comments:

  • introduction section explains what is the software quality goal, why or to whom it matters.
  • Rule Details and Options explains how to use the rule to achieve the goal.

In some rule docs, introduction leans forward into how and Rule Details leans backward into why. Here are two items in my mental check list:

  • Make sure an answer is clear in context if the reader asks “why is the doc telling me this?”
  • Reorganize fuzzy repetitions which could cause readers to ask “is the doc repeating the same thing or explaining something else?”

@pedrottimark pedrottimark merged commit 89580a4 into eslint:master Jun 2, 2016
@scriptdaemon scriptdaemon deleted the docs-stylistic-issues-5 branch June 2, 2016 20:57
@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

5 participants