This repository was archived by the owner on Jul 31, 2023. It is now read-only.
docs: fix documentation about linter behavior #730
Merged
Conversation
This file contains hidden or 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
|
This PR has not had activity for 30 days. It will be automatically closed in 7 days. |
|
Please don't auto close this PR. It's awaiting review. |
|
This PR has not had activity for 30 days. It will be automatically closed in 7 days. |
|
Please don't auto close this PR. It's awaiting review. |
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.
The troubleshooting document says that linters are run from the workspace root:
However, as reported in #717, linters are in fact not run from the workspace root.
This comment says that not running from the workspace root is intentional. It allows people to put multiple linter configuration files in the project. We expect linters to look recursively up the directory tree to find their configuration file.
This means that the behavior is not a bug. The documentation is wrong.
This pull request fixes the documentation.