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: add clarifications to readme #303

Closed
wants to merge 2 commits into from

Conversation

benmccann
Copy link

  • show how to set it up without the recommended configs. I only wanted to setup a single rule and had a very difficult time
  • show the new config format first and the legacy format after
  • don't duplicate legend symbols

Copy link

@scagood scagood left a comment

Choose a reason for hiding this comment

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

I generally like the docs changes, I have added a couple of small points.

Thank you :)

README.md Outdated Show resolved Hide resolved
Comment on lines +82 to +84
"plugins": {
"n": node
},
Copy link

Choose a reason for hiding this comment

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

Im not sure this'll work in the legacy version?

Copy link
Author

Choose a reason for hiding this comment

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

I don't know. I only have the new version to test on. We can remove this section

Co-authored-by: Sebastian Good <[email protected]>
Comment on lines +82 to +84
"plugins": {
"n": node
},

Choose a reason for hiding this comment

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

in eslintrc mode, it should be:

Suggested change
"plugins": {
"n": node
},
"plugins": ["n"],

@aladdin-add
Copy link

can you look at the ci failing - seems markdown-lint was not happy somehow: https://github.com/eslint-community/eslint-plugin-n/actions/runs/9725270531/job/26842381101?pr=303

@aladdin-add
Copy link

it has been landed in dbdfa8e. thanks for contributing!:)

1 similar comment
@aladdin-add
Copy link

it has been landed in dbdfa8e. thanks for contributing!:)

@aladdin-add aladdin-add closed this Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants