8000 fix doc for annotation_clip parameter · matplotlib/matplotlib@fdcd0f5 · GitHub
[go: up one dir, main page]

Skip to content

Commit fdcd0f5

Browse files
committed
fix doc for annotation_clip parameter
1 parent d2e5124 commit fdcd0f5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

lib/matplotlib/text.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1767,14 +1767,14 @@ def transform(renderer) -> Transform
17671767
centered in the text box.
17681768
17691769
annotation_clip : bool or None, default: None
1770-
Whether to draw the annotation when the annotation point *xy* is
1771-
outside the axes area.
1770+
Whether to clip (i.e. not draw) the annotation when the annotation
1771+
point *xy* is outside the axes area.
17721772
1773-
- If *True*, the annotation will only be drawn when *xy* is
1774-
within the axes.
1773+
- If *True*, the annotation will be clipped when *xy* is outside
1774+
the axes.
17751775
- If *False*, the annotation will always be drawn.
1776-
- If *None*, the annotation will only be drawn when *xy* is
1777-
within the axes and *xycoords* is 'data'.
1776+
- If *None*, the annotation will be clipped when *xy* is outside
1777+
the axes and *xycoords* is 'data'.
17781778
17791779
**kwargs
17801780
Additional kwargs are passed to `~matplotlib.text.Text`.

0 commit comments

Comments
 (0)
0