From 8759fb8d3718c6e85e27631a80bec0e58f271d4e Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Wed, 22 Nov 2023 21:48:18 -0600 Subject: [PATCH] Tweak docs for `FileConfigTestCase` --- src/wuttjamaican/testing.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/wuttjamaican/testing.py b/src/wuttjamaican/testing.py index d675140..4f25a43 100644 --- a/src/wuttjamaican/testing.py +++ b/src/wuttjamaican/testing.py @@ -32,15 +32,15 @@ from unittest import TestCase class FileConfigTestCase(TestCase): """ - Common base class for test suites which write temporary config - files, for sake of testing the config constructor etc. + Common base class for test suites which write temporary files, for + sake of testing the config constructor etc. This inherits from :class:`python:unittest.TestCase` and adds the following features: Creates a temporary folder on setup, and removes it on teardown. Adds the :meth:`write_file()` method to help with creating - temporary config files etc. + temporary files. .. attribute:: tempdir @@ -48,6 +48,7 @@ class FileConfigTestCase(TestCase): """ def setUp(self): + """ """ self.setup_file_config() def setup_file_config(self): @@ -59,6 +60,7 @@ class FileConfigTestCase(TestCase): self.tempdir = tempfile.mkdtemp() def tearDown(self): + """ """ self.teardown_file_config() def teardown_file_config(self): @@ -74,7 +76,7 @@ class FileConfigTestCase(TestCase): Write a new file (in temporary folder) with the given filename and content, and return its full path. For instance:: - myfilepath = self.write_file('my.conf', '') + myconf = self.write_file('my.conf', '') """ path = os.path.join(self.tempdir, filename) with open(path, 'wt') as f: