Merge pull request #15897 from timhoffm/doc-tri-analyzer

timhoffm · web-flow · commit 9d00ca839e5f · 2019-12-16T00:57:38.000+01:00
Cleanup TriAnalyzer docs
diff --git a/lib/matplotlib/tri/tritools.py b/lib/matplotlib/tri/tritools.py
@@ -12,18 +12,17 @@ class TriAnalyzer:
     """
     Define basic tools for triangular mesh analysis and improvement.
 
-    A TriAnalyzer encapsulates a :class:`~matplotlib.tri.Triangulation`
-    object and provides basic tools for mesh analysis and mesh improvement.
-
-    Parameters
-    ----------
-    triangulation : :class:`~matplotlib.tri.Triangulation` object
-        The encapsulated triangulation to analyze.
+    A TriAnalyzer encapsulates a `~matplotlib.tri.Triangulation` object and
+    provides basic tools for mesh analysis and mesh improvement.
 
     Attributes
     ----------
-    `scale_factors`
+    scale_factors
 
+    Parameters
+    ----------
+    triangulation : `~matplotlib.tri.Triangulation`
+        The encapsulated triangulation to analyze.
     """
     def __init__(self, triangulation):
         cbook._check_isinstance(Triangulation, triangulation=triangulation)
@@ -34,12 +33,10 @@ def scale_factors(self):
         """
         Factors to rescale the triangulation into a unit square.
 
-        Returns *k*, tuple of 2 scale factors.
-
         Returns
         -------
-        k : tuple of 2 floats (kx, ky)
-            Tuple of floats that would rescale the triangulation :
+        k : (float, float)
+            Scaling factors (kx, ky) so that the triangulation
             ``[triangulation.x * kx, triangulation.y * ky]``
             fits exactly inside a unit square.
 
@@ -52,7 +49,7 @@ def scale_factors(self):
 
     def circle_ratios(self, rescale=True):
         """
-        Returns a measure of the triangulation triangles flatness.
+        Return a measure of the triangulation triangles flatness.
 
         The ratio of the incircle radius over the circumcircle radius is a
         widely used indicator of a triangle flatness.
@@ -61,22 +58,21 @@ def circle_ratios(self, rescale=True):
 
         To avoid unduly low values due to a difference of scale between the 2
         axis, the triangular mesh can first be rescaled to fit inside a unit
-        square with :attr:`scale_factors` (Only if *rescale* is True, which is
+        square with `scale_factors` (Only if *rescale* is True, which is
         its default value).
 
         Parameters
         ----------
         rescale : bool, default: True
             If True, a rescaling will be internally performed (based on
-            :attr:`scale_factors`, so that the (unmasked) triangles fit
+            `scale_factors`, so that the (unmasked) triangles fit
             exactly inside a unit square mesh.
 
         Returns
         -------
         circle_ratios : masked array
-            Ratio of the incircle radius over the
-            circumcircle radius, for each 'rescaled' triangle of the
-            encapsulated triangulation.
+            Ratio of the incircle radius over the circumcircle radius, for
+            each 'rescaled' triangle of the encapsulated triangulation.
             Values corresponding to masked triangles are masked out.
 
         """
@@ -121,7 +117,7 @@ def circle_ratios(self, rescale=True):
 
     def get_flat_tri_mask(self, min_circle_ratio=0.01, rescale=True):
         """
-        Eliminates excessively flat border triangles from the triangulation.
+        Eliminate excessively flat border triangles from the triangulation.
 
         Returns a mask *new_mask* which allows to clean the encapsulated
         triangulation from its border-located flat triangles
@@ -137,15 +133,14 @@ def get_flat_tri_mask(self, min_circle_ratio=0.01, rescale=True):
 
         Parameters
         ----------
-        min_circle_ratio : float, optional
+        min_circle_ratio : float, default: 0.01
             Border triangles with incircle/circumcircle radii ratio r/R will
-            be removed if r/R < *min_circle_ratio*. Default value: 0.01
-        rescale : bool, optional
+            be removed if r/R < *min_circle_ratio*.
+        rescale : bool, default: True
             If True, a rescaling will first be internally performed (based on
-            :attr:`scale_factors` ), so that the (unmasked) triangles fit
-            exactly inside a unit square mesh. This rescaling accounts for the
-            difference of scale which might exist between the 2 axis. Default
-            (and recommended) value is True.
+            `scale_factors`), so that the (unmasked) triangles fit exactly
+            inside a unit square mesh. This rescaling accounts for the
+            difference of scale which might exist between the 2 axis.
 
         Returns
         -------
@@ -206,11 +201,11 @@ def _get_compressed_triangulation(self, return_tri_renum=False,
 
         Parameters
         ----------
-        return_tri_renum : bool, optional
+        return_tri_renum : bool, default: False
             Indicates whether a renumbering table to translate the triangle
             numbers from the encapsulated triangulation numbering into the
             new (compressed) renumbering will be returned.
-        return_node_renum : bool, optional
+        return_node_renum : bool, default: False
             Indicates whether a renumbering table to translate the nodes
             numbers from the encapsulated triangulation numbering into the
             new (compressed) renumbering will be returned.
