update test procedure for docstring related functions

Author: TomDonoghue

fooof/tests/conftest.py

@@ -8,7 +8,7 @@
 
 from fooof.core.modutils import safe_import
 
-from fooof.tests.tutils import get_tfm, get_tfg, get_tbands, get_tresults
+from fooof.tests.tutils import get_tfm, get_tfg, get_tbands, get_tresults, get_tdocstring
 from fooof.tests.settings import (BASE_TEST_FILE_PATH, TEST_DATA_PATH,
                                   TEST_REPORTS_PATH, TEST_PLOTS_PATH)
 
@@ -52,6 +52,10 @@ def tbands():
 def tresults():
     yield get_tresults()
 
+@pytest.fixture(scope='function')
+def tdocstring():
+    yield get_tdocstring()
+
 @pytest.fixture(scope='session')
 def skip_if_no_mpl():
     if not safe_import('matplotlib'):

fooof/tests/core/test_modutils.py

@@ -33,43 +33,13 @@ def subfunc_bad():
     with raises(ImportError):
         subfunc_bad()
 
-def test_docs_drop_param():
+def test_docs_drop_param(tdocstring):
 
-    ds = """STUFF
-
-    Parameters
-    ----------
-    first : thing
-        Words, words, words.
-    second : stuff
-        Words, words, words.
-
-    Returns
-    -------
-    out : yay
-        Words, words, words.
-    """
-
-    out = docs_drop_param(ds)
+    out = docs_drop_param(tdocstring)
     assert 'first' not in out
     assert 'second' in out
 
-def test_docs_append_to_section():
-
-    ds = """STUFF
-
-    Parameters
-    ----------
-    first : thing
-        Words, words, words.
-    second : stuff
-        Words, words, words.
-
-    Returns
-    -------
-    out : yay
-        Words, words, words.
-    """
+def test_docs_append_to_section(tdocstring):
 
     section = 'Parameters'
     add = \
@@ -78,7 +48,7 @@ def test_docs_append_to_section():
         Added description.
     """
 
-    new_ds = docs_append_to_section(ds, section, add)
+    new_ds = docs_append_to_section(tdocstring, section, add)
 
     assert 'third' in new_ds
     assert 'Added description' in new_ds

fooof/tests/tutils.py

@@ -54,6 +54,27 @@ def get_tresults():
                         r_squared=0.97, error=0.01,
                         gaussian_params=np.array([[10.0, 1.25, 1.0], [20.0, 1.0, 1.5]]))
 
+def get_tdocstring():
+    """Get an example docstring, for testing."""
+
+    docstring = \
+    """This is a test doctring.
+
+    Parameters
+    ----------
+    first : thing
+        Words, words, words.
+    second : stuff
+        Words, words, words.
+
+    Returns
+    -------
+    out : yay
+        Words, words, words.
+    """
+
+    return docstring
+
 def default_group_params():
     """Create default parameters for generating a test group of power spectra."""