Skip to content

Clarify docs of set_powerlimits() #17590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 9, 2020

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Jun 8, 2020

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 tacaswell force-pushed the doc-set_powerlimits branch from 0423ca6 to f5e2f36 Compare June 9, 2020 18:30
@tacaswell
Copy link
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
Copy link
Member Author

timhoffm commented Jun 9, 2020

I approve the default values.

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

@timhoffm timhoffm merged commit 879d1cf into matplotlib:master Jun 9, 2020
@timhoffm timhoffm deleted the doc-set_powerlimits branch June 9, 2020 19:55
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