DOC: refactor docstrings from build warnings

matthew-brett · matthew-brett · commit 24fceec757ce · 2017-03-13T16:03:43.000-07:00
Attempt to fix some build warnings by clearing up the docstrings; not
much success.
diff --git a/nipy/pkg_info.py b/nipy/pkg_info.py
@@ -12,19 +12,19 @@ def pkg_commit_hash(pkg_path):
     ''' Get short form of commit hash given directory `pkg_path`
 
     There should be a file called 'COMMIT_INFO.txt' in `pkg_path`.  This is a
-    file in INI file format, with at least one section: ``commit hash``, and two
-    variables ``archive_subst_hash`` and ``install_hash``.  The first has a
+    file in INI file format, with at least one section: ``commit hash``, and
+    two variables ``archive_subst_hash`` and ``install_hash``.  The first has a
     substitution pattern in it which may have been filled by the execution of
     ``git archive`` if this is an archive generated that way.  The second is
     filled in by the installation, if the installation is from a git archive.
 
     We get the commit hash from (in order of preference):
 
-    * A substituted value in ``archive_subst_hash``
-    * A written commit hash value in ``install_hash`
+    * A substituted value in ``archive_subst_hash``;
+    * A written commit hash value in ``install_hash``;
     * git's output, if we are in a git repository
 
-    If all these fail, we return a not-found placeholder tuple
+    If all these fail, we return a not-found placeholder tuple.
 
     Parameters
     -------------
diff --git a/nipy/testing/nosetester.py b/nipy/testing/nosetester.py
@@ -10,8 +10,8 @@
 def fpw_opt_str():
     """ Return first-package-wins option string for this version of nose
 
-    Versions of nose prior to 1.1.0 needed ``=True`` for ``first-package-wins``,
-    versions after won't accept it.
+    Versions of nose prior to 1.1.0 needed ``=True`` for
+    ``first-package-wins``, versions after won't accept it.
 
     changeset:   816:c344a4552d76
     http://code.google.com/p/python-nose/issues/detail?id=293
@@ -39,8 +39,8 @@ def fpw_opt_str():
 def prepare_imports():
     """ Prepare any imports for testing run
 
-    At the moment, we prepare matplotlib by trying to make it use a backend that
-    does not need a display
+    At the moment, we prepare matplotlib by trying to make it use a backend
+    that does not need a display.
     """
     try:
         import matplotlib as mpl
@@ -53,9 +53,9 @@ def prepare_imports():
 class NipyNoseTester(NoseTester):
     """ Numpy-like testing class
 
-    * Removes some numpy-specific excludes
-    * Disables numpy's fierce clearout of module import context for doctests
-    * Run doctests by default
+    * Removes some numpy-specific excludes;
+    * Disables numpy's fierce clearout of module import context for doctests;
+    * Run doctests by default.
 
     """
     excludes = []
@@ -77,13 +77,14 @@ def test(self, label='fast', verbose=1, extra_argv=None, doctests=True,
         ----------
         label : {'fast', 'full', '', attribute identifier}, optional
             Identifies the tests to run. This can be a string to pass to
-            directly the nosetests executable with the '-A' option (an attribute
-            identifier), or one of several special values.  Special values are:
+            directly the nosetests executable with the '-A' option (an
+            attribute identifier), or one of several special values.  Special
+            values are:
 
             * 'fast' - the default - which corresponds to the ``nosetests -A``
-              option of 'not slow'.
+              option of 'not slow';
             * 'full' - fast (as above) and slow tests as in the
-              'no -A' option to nosetests - this is the same as ''.
+              'no -A' option to nosetests - this is the same as '';
             * None or '' - run all tests.
 
         verbose : int, optional
