MAINT: Updates to formatters in `matplotlib.ticker` #6253

madphysicist · Mar 31, 2016

This PR is a split from #6251. Most of the changes are to docs, but there are two minor code changes:

__all__ has been moved to the top of the file and a couple of missing formatters were added to it.
A second format (position) is permitted in the string for the new-style string formatter.

As the title suggests, only formatters were affected. Locators were left untouched.

I have retained the original commits until the PR is reviewed to make sure that I did the split correctly.

independent

position

Does it make sense to document both class and __init__? I think Sphinx has a setting for it, so it may ignore one or the other, or even just combine both together.

Good point. Merged into class description. It is more likely to get picked up and put in the right place in case there is a difference.

What's Limits? There's no argument with that name.

Does this currently work? Should it have a not in there?

This particular method I have no idea. The formatter itself seems to work OK though. I will check right now.

This method does nothing for this particular class since self.labelOnlyBase is not used in self.pprint_val. However, it does work for the LogFormatterExponent class, which extends this one. The old docs and the method name are indeed very misleading. labelOnlyBase is named correctly (as I have noted in the updated docs). If it is True, minor ticks will not be shown, which is exactly the opposite of what the name of the method implies. I did not find any explicit calls to this method in matplotlib. Am I free to modify the parameter name to say labelMinor and set self.labelOnlyBase = not labelMinor?

Yes, but can you do that in a separate PR? The doc updates are non-controversial and should go in, but the API change should get more attention.

Makes sense, will do.

I have opened up #6264 with the code change.

tacaswell · Apr 11, 2016

This looks good, but needs a rebase 😞 \

madphysicist · Apr 11, 2016

Fixed. I've been spoiled by Homu on numpy.

tacaswell · Apr 28, 2016

backported to v2.x as 668f292

mdboom added the needs_review label Mar 31, 2016

madphysicist referenced this pull request Mar 31, 2016
Merged
ENH: Added a `PercentFormatter` class to `matplotlib.ticker` #6251

tacaswell modified the milestone: 2.1 (next point release), 2.0 (style change major release) Apr 2, 2016

madphysicist referenced this pull request Apr 3, 2016
Closed
Updated argument to `mpl.ticker.LogFormatter.label_minor` #6264

tacaswell merged commit 8658721 into matplotlib:master Apr 28, 2016
2 checks passed

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details

continuous-integration/travis-ci/pr The Travis CI build passed
Details

tacaswell removed the needs_review label Apr 28, 2016

madphysicist deleted the madphysicist:ticker-formatter-maint branch May 1, 2016

              return self.__call__(value)
          def format_data_short(self, value):
-    -        """return a short string version"""
+    +        """
+    +        Return a short string version of the tick value.
+    +
+    +        Defaults to the position-indepedent long value.

              return self.func(x, pos)
      class FormatStrFormatter(Formatter):
          """
-    -    Use an old-style ('%' operator) format string to format the tick
+    +    Use an old-style ('%' operator) format string to format the tick.
+    +
+    +    The format string should have a single variable format (%) in it.
+    +    It will be applied to the value (not the postition) of the tick.

              Sets size thresholds for scientific notation.
-    -        e.g., ``formatter.set_powerlimits((-3, 4))`` sets the pre-2007 default
-    -        in which scientific notation is used for numbers less than 1e-3 or
-    -        greater than 1e4.
-    -        See also :meth:`set_scientific`.
-    -        '''
+    +        Limits is a two-element sequence containing the powers of 10

              self._base = base
          def label_minor(self, labelOnlyBase):
-    -        'switch on/off minor ticks labeling'
+    +        """
+    +        Switch minor tick labeling on or off.
+    +
+    +        ``labelOnlyBase=True`` to turn off minor ticks.
+    +        """

madphysicist	`MAINT: Updated mailmap`		`eeb7658`
madphysicist	`ENH: Added support for both x and pos to StrMethodFormatter` This should not break backwards compatibility since extra keywords are allowed		`9ba1428`
madphysicist	`DOC: Updated docs for formatters in ticker`		`89a1ba1`
madphysicist	`TST: Test for new pos format`		`9cb7ee8`
madphysicist	`MAINT: Fixed up __all__ in ticker` Moved to the top and added missing formatter classes. Probably missing some locators too, but that's for the future.		`864a6cc`
madphysicist	`DOC: Wrapped to 72 chars and fixed a couple of missed spots`		`c94d0b1`
madphysicist	`Responses to PR#6253`	All checks have passed 2 successful checks continuous-integration/appveyor/pr — AppVeyor build succeeded Details continuous-integration/travis-ci/pr — The Travis CI build passed Details	`29b2ea6`

matplotlib/matplotlib

MAINT: Updates to formatters in `matplotlib.ticker` #6253

madphysicist commented Mar 31, 2016

mdboom added the needs_review label Mar 31, 2016

madphysicist referenced this pull request Mar 31, 2016

ENH: Added a `PercentFormatter` class to `matplotlib.ticker` #6251

QuLogic commented on an outdated diff Mar 31, 2016

QuLogic commented on an outdated diff Mar 31, 2016

QuLogic and 1 other commented on an outdated diff Mar 31, 2016

QuLogic commented on an outdated diff Mar 31, 2016

tacaswell commented on the diff Apr 2, 2016

tacaswell modified the milestone: 2.1 (next point release), 2.0 (style change major release) Apr 2, 2016

madphysicist referenced this pull request Apr 3, 2016

Updated argument to `mpl.ticker.LogFormatter.label_minor` #6264

tacaswell commented Apr 11, 2016

madphysicist added some commits Mar 29, 2016

madphysicist commented Apr 11, 2016

tacaswell merged commit `8658721` into matplotlib:master Apr 28, 2016
2 checks passed

2 checks passed

tacaswell removed the needs_review label Apr 28, 2016

tacaswell added a commit that referenced this pull request Apr 28, 2016

tacaswell commented Apr 28, 2016

madphysicist deleted the madphysicist:ticker-formatter-maint branch May 1, 2016

		def __init__(self, useOffset=None, useMathText=None, useLocale=None):
		+ """

matplotlib/matplotlib

Join GitHub today

MAINT: Updates to formatters in `matplotlib.ticker` #6253

Conversation

madphysicist commented Mar 31, 2016

mdboom added the needs_review label Mar 31, 2016

madphysicist referenced this pull request Mar 31, 2016

Show 1 comment Hide comment QuLogic commented on an outdated diff Mar 31, 2016

Show 1 comment Hide comment QuLogic commented on an outdated diff Mar 31, 2016

Show 2 comments Hide comments QuLogic and 1 other commented on an outdated diff Mar 31, 2016

Show 1 comment Hide comment QuLogic commented on an outdated diff Mar 31, 2016

tacaswell commented on the diff Apr 2, 2016

tacaswell modified the milestone: 2.1 (next point release), 2.0 (style change major release) Apr 2, 2016

madphysicist referenced this pull request Apr 3, 2016

tacaswell commented Apr 11, 2016

madphysicist added some commits Mar 29, 2016

All checks have passed

madphysicist commented Apr 11, 2016

Hide details View details tacaswell merged commit 8658721 into matplotlib:master Apr 28, 2016 2 checks passed

2 checks passed

tacaswell removed the needs_review label Apr 28, 2016

tacaswell added a commit that referenced this pull request Apr 28, 2016

tacaswell commented Apr 28, 2016

madphysicist deleted the madphysicist:ticker-formatter-maint branch May 1, 2016

QuLogic commented on an outdated diff Mar 31, 2016

QuLogic commented on an outdated diff Mar 31, 2016

QuLogic and 1 other commented on an outdated diff Mar 31, 2016

QuLogic commented on an outdated diff Mar 31, 2016

tacaswell merged commit `8658721` into matplotlib:master Apr 28, 2016
2 checks passed