pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-06 21:16:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update fixture README with descriptions

Browse source
This commit is contained in:
Ian Cordasco 2016-01-19 06:43:47 -06:00
parent dcf696d678
commit 4e294af81c
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
tests/fixtures/config_files/README.rst vendored
View file

@ -20,3 +20,19 @@ Purposes of existing fixtures
This should only be used when providing config file(s) specified by the This should only be used when providing config file(s) specified by the
user on the command-line. 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).