Add doc for exclude option + globs #222
Conversation
MVrachev
requested review from
joshuagl and
ericwb
and removed request for
joshuagl
|
We should merge first pull request number 213 before this one. |
joshuagl
added
the
ready-to-merge
|
There is no need to put "which has to be merged first." in PR message bodies. If there is a dependency, create the dependency using a git rebase. |
|
"We need documentation for the exclude option and how a user can user globs." - This statement is strange. It sounds as if this is an issue, not a fix. |
docs/configuration.md
Outdated
| Precaution uses a variety of tools under the hood without exposing | ||
| implementation details and complexity of the underlying tools to the user. | ||
|
|
||
| Concretely, this means that Precaution ignores any tool specific configuration |
There was a problem hiding this comment.
Because of this sentence is connected with the statement above.
“Precaution uses a variety of linters under the hood without exposing
implementation details and complexity of the underlying tools to the user and because of that we ignore linter specific configuration files”.
There was a problem hiding this comment.
I like and because of that better than having a separate statement starting with "concretely".
I think even better would be to expand on the reasoning a bit.
Precaution uses a variety of linters under the hood without exposing implementation details and complexity of the underlying tools to the user. Because of that, and in order to prevent conflict with any configuration files which may exist in the target git repository, Precaution ignores any linter specific configuration files.
joshuagl
removed
the
ready-to-merge
|
I updated my pr with the suggestion from @joshuagl about the Glob syntax in the exclude option. |
|
I updated my pr with the last suggestions from @joshuagl #222 (comment). |
Codecov Report
@@ Coverage Diff @@
## master #222 +/- ##
======================================
Coverage 98.3% 98.3%
======================================
Files 18 18
Lines 353 353
Branches 38 38
======================================
Hits 347 347
Misses 6 6Continue to review full report at Codecov.
|
MVrachev
added
ready-to-merge
Related to pull request #213 which has to be merged first. We need documentation for the exclude option and how a user can user globs. Signed-off-by: Martin Vrachev <mvrachev@vmware.com>
Related to pull request #213
which has to be merged first.
We need documentation for the exclude option and how a user can user
globs.
Signed-off-by: Martin Vrachev mvrachev@vmware.com