@@ -387,7 +387,7 @@ def __init__(self, transform, label_x, label_y, length=0.15,
387
387
text_props = None , arrow_props = None ,
388
388
** kwargs ):
389
389
"""
390
- Draw a direction indicator arrows
390
+ Draw two perpendicular arrows to indicate directions.
391
391
392
392
Parameters
393
393
----------
@@ -408,7 +408,7 @@ def __init__(self, transform, label_x, label_y, length=0.15,
408
408
Defaults to 0.08.
409
409
410
410
loc : int, optional
411
- Location of this size bar . Valid location codes are::
411
+ Location of the direction arrows . Valid location codes are::
412
412
413
413
'upper right' : 1,
414
414
'upper left' : 2,
@@ -433,19 +433,19 @@ def __init__(self, transform, label_x, label_y, length=0.15,
433
433
Defaults to 1.
434
434
435
435
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
437
437
size. Defaults to 0.4.
438
438
439
439
borderpad : int or float, optional
440
440
Border padding, in fraction of the font size.
441
441
Defaults to 0.4.
442
442
443
443
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 .
445
445
Defaults to False.
446
446
447
447
color : str, optional
448
- Color for the size bar and label .
448
+ Color for the arrows and labels .
449
449
Defaults to white.
450
450
451
451
alpha : int or float, optional
@@ -464,15 +464,15 @@ def __init__(self, transform, label_x, label_y, length=0.15,
464
464
Defaults to 0.15.
465
465
466
466
head_width : int or float, optional
467
- Width of arrow head, sendt to ArrowStyle.
467
+ Width of arrow head, sent to ArrowStyle.
468
468
Defaults to 10.
469
469
470
470
head_length : int or float, optional
471
- Length of arrow head, sendt to ArrowStyle.
471
+ Length of arrow head, sent to ArrowStyle.
472
472
Defaults to 15.
473
473
474
474
tail_width : int or float, optional
475
- Width of arrow tail, sendt to ArrowStyle.
475
+ Width of arrow tail, sent to ArrowStyle.
476
476
Defaults to 2.
477
477
478
478
text_props, arrow_props : dict
@@ -500,7 +500,7 @@ def __init__(self, transform, label_x, label_y, length=0.15,
500
500
501
501
Notes
502
502
-----
503
- If *prop* is passed as a keyworded argument, but *fontproperties* is
503
+ If *prop* is passed as a keyword argument, but *fontproperties* is
504
504
not, then *prop* is be assumed to be the intended *fontproperties*.
505
505
Using both *prop* and *fontproperties* is not supported.
506
506
0 commit comments