Add docstrings checking

Author: amorison

docs/conf.py

@@ -61,7 +61,7 @@ def __getattr__(cls, name):
 ]
 
 autodoc_member_order = 'bysource'
-autoclass_content = 'both'
+autoclass_content = 'class'
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

stagpy/__main__.py

@@ -1,4 +1,4 @@
-"""The stagpy module is callable"""
+"""The stagpy module is callable."""
 
 import importlib
 import signal
@@ -9,7 +9,7 @@
 
 
 def main():
-    """StagPy entry point"""
+    """Implement StagPy entry point."""
     if not DEBUG:
         signal.signal(signal.SIGINT, sigint_handler)
         warnings.simplefilter('ignore')

stagpy/_step.py

@@ -23,7 +23,6 @@
 
 
 class _Geometry:
-
     """Geometry information.
 
     It is deduced from the information in the header of binary field files
@@ -101,7 +100,7 @@ def __init__(self, header, par):
             self._curv_meshes = (t_mesh, p_mesh, r_mesh)
 
     def _init_shape(self):
-        """Determine shape of geometry"""
+        """Determine shape of geometry."""
         shape = self._par['geometry']['shape'].lower()
         aspect = self._header['aspect']
         if self.rcmb is not None and self.rcmb >= 0:
@@ -178,7 +177,6 @@ def __getattr__(self, attr):
 
 
 class _Fields(Mapping):
-
     """Fields data structure.
 
     The :attr:`Step.fields` attribute is an instance of this class.
@@ -308,7 +306,6 @@ def geom(self):
 
 
 class _Tracers:
-
     """Tracers data structure.
 
     The :attr:`Step.tracers` attribute is an instance of this class.
@@ -349,7 +346,6 @@ def __iter__(self):
 
 
 class Step:
-
     """Time step data structure.
 
     Elements of :class:`_Steps` and :class:`_Snaps` instances are all
@@ -369,27 +365,25 @@ class Step:
         >>> assert(sdat.snaps[n].isnap == n)
         >>> assert(sdat.steps[n].geom is sdat.steps[n].fields.geom)
         >>> assert(sdat.snaps[n] is sdat.snaps[n].fields.step)
+
+    Args:
+        istep (int): the index of the time step that the instance
+            represents.
+        sdat (:class:`~stagpy.stagyydata.StagyyData`): the StagyyData
+            instance owning the :class:`Step` instance.
+
+    Attributes:
+        istep (int): the index of the time step that the instance
+            represents.
+        sdat (:class:`~stagpy.stagyydata.StagyyData`): the StagyyData
+            instance owning the :class:`Step` instance.
+        fields (:class:`_Fields`): fields available at this time step.
+        sfields (:class:`_Fields`): surface fields available at this time
+            step.
+        tracers (:class:`_Tracers`): tracers available at this time step.
     """
 
     def __init__(self, istep, sdat):
-        """Initialization of instances:
-
-        Args:
-            istep (int): the index of the time step that the instance
-                represents.
-            sdat (:class:`~stagpy.stagyydata.StagyyData`): the StagyyData
-                instance owning the :class:`Step` instance.
-
-        Attributes:
-            istep (int): the index of the time step that the instance
-                represents.
-            sdat (:class:`~stagpy.stagyydata.StagyyData`): the StagyyData
-                instance owning the :class:`Step` instance.
-            fields (:class:`_Fields`): fields available at this time step.
-            sfields (:class:`_Fields`): surface fields available at this time
-                step.
-            tracers (:class:`_Tracers`): tracers available at this time step.
-        """
         self.istep = istep
         self.sdat = sdat
         self.fields = _Fields(self, phyvars.FIELD, phyvars.FIELD_EXTRA,
@@ -451,7 +445,6 @@ def isnap(self):
 
 
 class EmptyStep(Step):
-
     """Dummy step object for nonexistent snaps.
 
     This class inherits from :class:`Step`, but its :meth:`__getattribute__`

stagpy/commands.py

@@ -54,7 +54,7 @@ def info_cmd():
 
 
 def _pretty_print(key_val, sep=': ', min_col_width=39, text_width=None):
-    """Print a iterable of key/values
+    """Print a iterable of key/values.
 
     Args:
         key_val (list of (str, str)): the pairs of section names and text.
@@ -96,7 +96,7 @@ def _pretty_print(key_val, sep=': ', min_col_width=39, text_width=None):
 
 
 def _layout(dict_vars, dict_vars_extra):
-    """Print nicely [(var, description)] from phyvars"""
+    """Print nicely [(var, description)] from phyvars."""
     desc = [(v, m.description) for v, m in dict_vars.items()]
     desc.extend((v, baredoc(m.description))
                 for v, m in dict_vars_extra.items())