Add README to fixtures directory

This commit is contained in:
Ian Cordasco 2016-01-10 09:50:16 -06:00
parent 7269d84845
commit 9231aae1d6

22
tests/fixtures/config_files/README.rst vendored Normal file
View file

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