diff options
| author | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-01-19 06:43:47 -0600 |
|---|---|---|
| committer | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-01-19 06:43:47 -0600 |
| commit | 4e294af81c14a627fa6a4771617a00a8a1abd293 (patch) | |
| tree | bed717b9a02318391415d3bca6a01873091fcb4b | |
| parent | dcf696d6786f936ed9dcfbdbf8e2d883266971fa (diff) | |
| download | flake8-4e294af81c14a627fa6a4771617a00a8a1abd293.tar.gz | |
Update fixture README with descriptions
| -rw-r--r-- | tests/fixtures/config_files/README.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/tests/fixtures/config_files/README.rst b/tests/fixtures/config_files/README.rst index b69e080..b00adad 100644 --- a/tests/fixtures/config_files/README.rst +++ b/tests/fixtures/config_files/README.rst @@ -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). |