[WIP] README: revisit config section #309
Open
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
Codecov Report
@@ Coverage Diff @@
## master #309 +/- ##
=======================================
Coverage 70.81% 70.81%
=======================================
Files 134 134
Lines 7709 7709
Branches 1253 1253
=======================================
Hits 5459 5459
Misses 1922 1922
Partials 328 328 |
blueyed
commented
Apr 11, 2019
| @@ -32,61 +32,27 @@ You can use Vint with | |||
| Configure | |||
| --------- | |||
|
|
|||
| Vint will read config files on the following priority order: | |||
| Vint will read config files from files named ``.vintrc.yaml``, ``.vintrc.yml``, | |||
There was a problem hiding this comment.
Suggested change
| Vint will read config files from files named ``.vintrc.yaml``, ``.vintrc.yml``, | |
| Vint will read its base configuration files named ``.vintrc.yaml``, ``.vintrc.yml``, |
| - `Project config <#project-config>`__: | ||
| - e.g. ``path/to/proj/.vintrc.yaml`` (the filename can be ``.vintrc.yml`` or ``.vintrc``) | ||
| 2. any of these files is read based on the current directory, which allows for | ||
| project specific settings. |
There was a problem hiding this comment.
be more specific here with regard to upward search, and where it starts (check the source)
|
|
||
| - `Comment config <#comment-config>`__ (highest priority): | ||
| - e.g. ``" vint: -ProhibitAbbreviationOption +ProhibitSetNoCompatible`` | ||
| 4. `Comment directives <#comment-directives>`__ (highest priority), e.g. |
There was a problem hiding this comment.
Maybe keep the old anchor names.
blueyed
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.