From ad8d10f0caec8f87d1aae89147f4131a4d8be5a8 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Sun, 23 Sep 2018 11:26:42 +0200 Subject: [PATCH] Use (float, float) as paramter type for 2D positions --- doc/devel/documenting_mpl.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst index 7602e45d2530..4e1414b8aeb8 100644 --- 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