Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e200c44

Browse files
Magnus Nordidahj
Magnus Nord
authored andcommitted
AnchoredDirectionArrows: minor docstring changes
1 parent b6b0ea2 commit e200c44

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

lib/mpl_toolkits/axes_grid1/anchored_artists.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ def __init__(self, transform, label_x, label_y, length=0.15,
387387
text_props=None, arrow_props=None,
388388
**kwargs):
389389
"""
390-
Draw a direction indicator arrows
390+
Draw two perpendicular arrows to indicate directions.
391391
392392
Parameters
393393
----------
@@ -408,7 +408,7 @@ def __init__(self, transform, label_x, label_y, length=0.15,
408408
Defaults to 0.08.
409409
410410
loc : int, optional
411-
Location of this size bar. Valid location codes are::
411+
Location of the direction arrows. Valid location codes are::
412412
413413
'upper right' : 1,
414414
'upper left' : 2,
@@ -433,19 +433,19 @@ def __init__(self, transform, label_x, label_y, length=0.15,
433433
Defaults to 1.
434434
435435
pad : int or float, optional
436-
Padding around the label and size bar, in fraction of the font
436+
Padding around the labels and arrows, in fraction of the font
437437
size. Defaults to 0.4.
438438
439439
borderpad : int or float, optional
440440
Border padding, in fraction of the font size.
441441
Defaults to 0.4.
442442
443443
frameon : bool, optional
444-
If True, draw a box around the horizontal bar and label.
444+
If True, draw a box around the arrows and labels.
445445
Defaults to False.
446446
447447
color : str, optional
448-
Color for the size bar and label.
448+
Color for the arrows and labels.
449449
Defaults to white.
450450
451451
alpha : int or float, optional
@@ -464,15 +464,15 @@ def __init__(self, transform, label_x, label_y, length=0.15,
464464
Defaults to 0.15.
465465
466466
head_width : int or float, optional
467-
Width of arrow head, sendt to ArrowStyle.
467+
Width of arrow head, sent to ArrowStyle.
468468
Defaults to 10.
469469
470470
head_length : int or float, optional
471-
Length of arrow head, sendt to ArrowStyle.
471+
Length of arrow head, sent to ArrowStyle.
472472
Defaults to 15.
473473
474474
tail_width : int or float, optional
475-
Width of arrow tail, sendt to ArrowStyle.
475+
Width of arrow tail, sent to ArrowStyle.
476476
Defaults to 2.
477477
478478
text_props, arrow_props : dict
@@ -500,7 +500,7 @@ def __init__(self, transform, label_x, label_y, length=0.15,
500500
501501
Notes
502502
-----
503-
If *prop* is passed as a keyworded argument, but *fontproperties* is
503+
If *prop* is passed as a keyword argument, but *fontproperties* is
504504
not, then *prop* is be assumed to be the intended *fontproperties*.
505505
Using both *prop* and *fontproperties* is not supported.
506506

0 commit comments

Comments
 (0)