8000 DOC: fix property docstrings · matplotlib/matplotlib@410ad06 · GitHub
[go: up one dir, main page]

Skip to content

Commit 410ad06

Browse files
committed
DOC: fix property docstrings
1 parent d00ff15 commit 410ad06

File tree

1 file changed

+4
-24
lines changed

1 file changed

+4
-24< 8000 /div>lines changed

lib/matplotlib/colorbar.py

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -512,61 +512,41 @@ def __init__(self, ax, mappable=None, *, cmap=None,
512512

513513
@property
514514
def locator(self):
515-
"""
516-
Major `~.Locator` being used for colorbar.
517-
"""
515+
""" Major tick `~.Locator` for the colorbar. """
518516
return self._long_axis().get_major_locator()
519517

520518
@locator.setter
521519
def locator(self, loc):
522-
"""
523-
Set the major `~.Locator` being used for colorbar.
524-
"""
525520
self._long_axis().set_major_locator(loc)
526521
self._locator = loc
527522

528523
@property
529524
def minorlocator(self):
530-
"""
531-
Minor `~.Locator` being used for colorbar.
532-
"""
525+
"""Minor tick `~.Locator` for the colorbar."""
533526
return self._long_axis().get_minor_locator()
534527

535528
@minorlocator.setter
536529
def minorlocator(self, loc):
537-
"""
538-
Set minor `~.Locator` being used for colorbar.
539-
"""
540530
self._long_axis().set_minor_locator(loc)
541531
self._minorlocator = loc
542532

543533
@property
544534
def formatter(self):
545-
"""
546-
Major `~.Formatter` being used for colorbar.
547-
"""
535+
"""Major tick label `~.Formatter` for the colorbar."""
548536
return self._long_axis().get_major_formatter()
549537

550538
@formatter.setter
551539
def formatter(self, fmt):
552-
"""
553-
Set major `~.Formatter` being used for colorbar.
554-
"""
555540
self._long_axis().set_major_formatter(fmt)
556541
self._formatter = fmt
557542

558543
@property
559544
def minorformatter(self):
560-
"""
561-
Minor `~.Formatter` being used for colorbar
562-
"""
545+
"""Minor tick `~.Formatter` for the colorbar."""
563546
return self._long_axis().get_minor_formatter()
564547

565548
@minorformatter.setter
566549
def minorformatter(self, fmt):
567-
"""
568-
Set minor `~.Formatter` being used for colorbar
569-
"""
570550
self._long_axis().set_minor_formatter(fmt)
571551
self._minorformatter = fmt
572552

0 commit comments

Comments
 (0)
0