summaryrefslogtreecommitdiff
path: root/tests/fixtures
diff options
context:
space:
mode:
authorIan Cordasco <graffatcolmingov@gmail.com>2016-01-10 09:50:16 -0600
committerIan Cordasco <graffatcolmingov@gmail.com>2016-01-10 09:50:16 -0600
commit9231aae1d6ecfca856e97fa4279cf06e83f42e57 (patch)
tree2e1fa8dd6b57b106ef66727eea4418a2ec3abece /tests/fixtures
parent7269d84845f9aa4896a418d6d594682ab0b6d074 (diff)
downloadflake8-9231aae1d6ecfca856e97fa4279cf06e83f42e57.tar.gz
Add README to fixtures directory
Diffstat (limited to 'tests/fixtures')
-rw-r--r--tests/fixtures/config_files/README.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/tests/fixtures/config_files/README.rst b/tests/fixtures/config_files/README.rst
new file mode 100644
index 0000000..b69e080
--- /dev/null
+++ b/tests/fixtures/config_files/README.rst
@@ -0,0 +1,22 @@
+About this directory
+====================
+
+The files in this directory are test fixtures for unit and integration tests.
+Their purpose is described below. Please note the list of file names that can
+not be created as they are already used by tests.
+
+New fixtures are preferred over updating existing features unless existing
+tests will fail.
+
+Files that should not be created
+--------------------------------
+
+- ``tests/fixtures/config_files/missing.ini``
+
+Purposes of existing fixtures
+-----------------------------
+
+``tests/fixtures/config_files/cli-specified.ini``
+
+ This should only be used when providing config file(s) specified by the
+ user on the command-line.