Docs: gitignore syntax updates (fixes #8139) #10776
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Please enter the commit message for your changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # # On branch gitignore-syntax-updates # Changes to be committed: #modified: docs/user-guide/command-line-interface.md #modified: docs/user-guide/configuring.md # Adds cross links between .eslintignore and --ignore-pattern sections. Adds link to --ignore-pattern section directing to .gitignore specs. Adds description to .eslintignore section that emphasizes forward slashes being necessary with examples of valid and invalid syntax. Adds explicit statements to both sections that support this example.
eslint-deprecated
bot
added
the
triage
santanaG
changed the title
platinumazure
approved these changes
Aug 20, 2018
docs/user-guide/configuring.md
Outdated
| * Lines preceded by `!` are negated patterns that re-include a pattern that was ignored by an earlier pattern. | ||
| * Ignore patterns behave according to the `.gitignore` [specification](https://git-scm.com/docs/gitignore). | ||
|
|
||
| Of particular note is that like `.gitignore` files all paths used as patterns for both `.eslintignore` and `--ignore-pattern` must use forward slashes as their path separators. |
There was a problem hiding this comment.
Nitpick: Could you add a comma after "like .gitignore files"?
There was a problem hiding this comment.
I welcome the nitpick and appreciate it. I am surprised I missed it even! Going to add now.
platinumazure
approved these changes
Aug 20, 2018
ilyavolodin
approved these changes
Aug 20, 2018
platinumazure
added
documentation
|
Thanks for contributing! |
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of this pull request? (put an "X" next to item)
[X ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Adds cross links between .eslintignore and --ignore-pattern sections.
Adds link to --ignore-pattern section directing to .gitignore specs.
Adds description to .eslintignore section that emphasizes forward slashes being necessary with examples of valid and invalid syntax.
Adds explicit statements to both sections that support this example.
Is there anything you'd like reviewers to focus on?
Ensuring that changes are clear and that they keep original entries' context.