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

Add `react/no-array-index-key` rule example to documentation #2220

Open
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
2 participants
@dmmarmol
Copy link

dmmarmol commented Mar 28, 2019

Improve documentation of this particular rule by adding a use case example.

Add `react/no-array-index-key` rule example to documentation
Improve documentation of this particular rule by adding a use case example.
```
{
"rules": {
"react/no-array-index-key": 0 // 0 = off, 1 = warn, 2 = error

This comment has been minimized.

Copy link
@ljharb

ljharb Apr 6, 2019

Collaborator

generally we don't document things like this, because it's basics of how eslint itself works. It's assumed that users of an eslint plugin know how eslint works.

This comment has been minimized.

Copy link
@dmmarmol

dmmarmol Apr 6, 2019

Author

I see your point but, as an eslint user, sometimes I found that there're many rules that either exptects a string like error or warn, while others could expect numbers, booleans or even objects or arrays. This made me waste some time until I found some example in the web about the correct usage of a specific rule.

I personally think that documenting this doesn't distract the user and also helps on document how this specific rule works.

This comment has been minimized.

Copy link
@ljharb

ljharb Apr 6, 2019

Collaborator

If so, then let's also audit every other rule doc, and make sure they all document themselves the same way?

This comment has been minimized.

Copy link
@ljharb

ljharb Apr 6, 2019

Collaborator

(do note tho, every rule without exception supports 0/1/2 or "off"/"warn"/"error"; the variability is only in additional configuration arguments)

This comment has been minimized.

Copy link
@dmmarmol

dmmarmol Apr 7, 2019

Author

I'd love to see every rule documented, but as you know there're a lot of them and it's better to start at some point if you truly consider it.
On the other side (and since I don't consider myself a an advanced eslint user), I wasn't fully aware of that rule (my bad for don't reading the eslint docs ).
As a conclusion, I see that you have a valid point about being redudant adding this as a documentation, but maybe it could help some begginers or anxiety devs like me :).

This comment has been minimized.

Copy link
@ljharb

ljharb Apr 8, 2019

Collaborator

I definitely think reducing confusion is good; but i don't think doing it piecemeal is likely to be effective.

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