From 96cc40dcffc90540c9e421255301771b1edf0661 Mon Sep 17 00:00:00 2001 From: Sylvain Bellemare Date: Wed, 20 Jul 2016 12:07:04 +0200 Subject: [PATCH] Add docstring that explains the fixture's purpose --- tests/test_config_utils.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tests/test_config_utils.py b/tests/test_config_utils.py index eb4eb5e5..ea58f61a 100644 --- a/tests/test_config_utils.py +++ b/tests/test_config_utils.py @@ -12,6 +12,13 @@ ORIGINAL_CONFIG = copy.deepcopy(bigchaindb._config) @pytest.fixture def ignore_local_config_file(monkeypatch): + """ + This fixture's purpose is to override the one under + :module:`tests/conftest.py` so that the original behaviour of + :func:`bigchaindb.config_utils.file_config` is restored, so that it can be + tested. + + """ from bigchaindb.config_utils import file_config monkeypatch.setattr('bigchaindb.config_utils.file_config', file_config)