Merge pull request #12227 from timhoffm/doc-parameter-types-pos

jklymak · web-flow · commit da2aeceb43af · 2018-09-23T08:16:41.000-07:00
Use (float, float) as paramter type for 2D positions
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -426,6 +426,8 @@ rules expand on them where the numpydoc conventions are not specific.
 
 Use ``float`` for a type that can be any number.
 
+Use ``(float, float)`` to describe a 2D position.
+
 Use ``array-like`` for homogeneous numeric sequences, which could
 typically be a numpy.array. Dimensionality may be specified using ``2D``,
 ``3D``, ``n-dimensional``. If you need to have variables denoting the
