mirror of
https://github.com/PyCQA/flake8.git
synced 2026-03-29 10:36:53 +00:00
Update fixture README with descriptions
This commit is contained in:
parent
dcf696d678
commit
4e294af81c
1 changed files with 16 additions and 0 deletions
16
tests/fixtures/config_files/README.rst
vendored
16
tests/fixtures/config_files/README.rst
vendored
|
|
@ -20,3 +20,19 @@ Purposes of existing fixtures
|
|||
|
||||
This should only be used when providing config file(s) specified by the
|
||||
user on the command-line.
|
||||
|
||||
``tests/fixtures/config_files/local-config.ini``
|
||||
|
||||
This should be used when providing config files that would have been found
|
||||
by looking for config files in the current working project directory.
|
||||
|
||||
|
||||
``tests/fixtures/config_files/no-flake8-section.ini``
|
||||
|
||||
This should be used when parsing an ini file without a ``[flake8]``
|
||||
section.
|
||||
|
||||
``tests/fixtures/config_files/user-config.ini``
|
||||
|
||||
This is an example configuration file that would be found in the user's
|
||||
home directory (or XDG Configuration Directory).
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue