Skip to content

[WIP] README: revisit config section#309

Open
blueyed wants to merge 1 commit into
Vimjas:masterfrom
blueyed:readme-revisit-config
Open

[WIP] README: revisit config section#309
blueyed wants to merge 1 commit into
Vimjas:masterfrom
blueyed:readme-revisit-config

Conversation

@blueyed
Copy link
Copy Markdown
Member

@blueyed blueyed commented Apr 11, 2019

No description provided.

@codecov-io
Copy link
Copy Markdown

Codecov Report

Merging #309 into master will not change coverage.
The diff coverage is n/a.

@@           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

Comment thread README.rst
---------

Vint will read config files on the following priority order:
Vint will read config files from files named ``.vintrc.yaml``, ``.vintrc.yml``,
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

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``,

Comment thread README.rst
- `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.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

be more specific here with regard to upward search, and where it starts (check the source)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Comment thread README.rst

- `Comment config <#comment-config>`__ (highest priority):
- e.g. ``" vint: -ProhibitAbbreviationOption +ProhibitSetNoCompatible``
4. `Comment directives <#comment-directives>`__ (highest priority), e.g.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Maybe keep the old anchor names.

@blueyed blueyed changed the title README: revisit config section [WIP] README: revisit config section Apr 11, 2019
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.

2 participants