FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Clarify docs of set_powerlimits() by timhoffm · Pull Request #17590 · matplotlib/matplotlib · GitHub

Repository navigation

Clarify docs of set_powerlimits() - #17590

Merged
timhoffm merged 2 commits into
matplotlib:masterfrom
timhoffm:doc-set_powerlimits
Jun 9, 2020
Merged

timhoffm merged 2 commits into
matplotlib:masterfrom
timhoffm:doc-set_powerlimits

Conversation

timhoffm commented Jun 8, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

PR Summary

Closes #15376.

Previous docstring:

Numbers below 10**min_exp and above 10**max_exp will be displayed in scientific notation.

This is not correct. In the above terminology one would have to write:

Numbers with absolute values below 10**(min_exp+1) and above 10**max_exp will be displayed in scientific notation.

which raises questions on the +1 for min_exp (and was suspected to be a bug in #15376). But actually, I think that's correct and it's better to think of the criterion in terms of the exponent that would be used for scientific notation.

tacaswell force-pushed the doc-set_powerlimits branch from 0423ca6 to f5e2f36 Compare June 9, 2020 18:30

Copy link
Copy Markdown
Member

I took the liberty of re-basing to unbreak the doc build and pushed a commit adding a note about the default values.

timhoffm commented Jun 9, 2020

Copy link
Copy Markdown
Member Author

I approve the default values.

Since each commit is mutually approved, I can merge 😄.

timhoffm merged commit 879d1cf into matplotlib:master Jun 9, 2020
timhoffm deleted the doc-set_powerlimits branch June 9, 2020 19:55
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ScalarFormatter.set_powerlimits documentation seems inconsistent

2 participants


Back | FazBrowse Home | New Git URL