From dac810e8da9012ad70d14e1ad1f14f18012dcdff Mon Sep 17 00:00:00 2001
From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Date: Sat, 4 Apr 2020 02:12:21 +0200
Subject: [PATCH] Clarify docs of Rectangle
---
lib/matplotlib/patches.py | 35 ++++++++++++++++++++++-------------
1 file changed, 22 insertions(+), 13 deletions(-)
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
index d7b326bb01a8..2f0b828d6cf6 100644
--- a/lib/matplotlib/patches.py
+++ b/lib/matplotlib/patches.py
@@ -705,8 +705,21 @@ def draw(self, renderer):
class Rectangle(Patch):
"""
- A rectangle with lower left at *xy* = (*x*, *y*) with
- specified *width*, *height* and rotation *angle*.
+ A rectangle defined via an anchor point *xy* and its *width* and *height*.
+
+ The rectangle extends from ``xy[0]`` to ``xy[0] + width`` in x-direction
+ and from ``xy[1]`` to ``xy[1] + height`` in y-direction. ::
+
+ : +------------------+
+ : | |
+ : height |
+ : | |
+ : (xy)---- width -----+
+
+ One may picture *xy* as the bottom left corner, but which corner *xy* is
+ actually depends on the the direction of the axis and the sign of *width*
+ and *height*; e.g. *xy* would be the bottom right corner if the x-axis
+ was inverted or if *width* was negative.
"""
def __str__(self):
@@ -720,22 +733,18 @@ def __init__(self, xy, width, height, angle=0.0, **kwargs):
Parameters
----------
xy : (float, float)
- The rectangle extends from xy[0] to xy[0] + width in
- x-direction and from xy[1] to xy[1] + height in y-direction.
+ The anchor point.
width : float
- Rectangle width
+ Rectangle width.
height : float
- Rectangle height
+ Rectangle height.
angle : float, default: 0
Rotation in degrees anti-clockwise about *xy*.
- fill : bool, default: True
- Whether to fill the rectangle.
-
- Notes
- -----
- Valid keyword arguments are:
- %(Patch)s
+ Other Parameters
+ ----------------
+ **kwargs : `.Patch` properties
+ %(Patch)s
"""
Patch.__init__(self, **kwargs)
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy