Make get_scale_docs() internal #12721
Merged
Conversation
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
0103d95 to
fcb8193
Compare
anntzer
approved these changes
Nov 2, 2018
jklymak
approved these changes
Nov 2, 2018
|
.... though I guess the doc build has to pass ;-) |
fcb8193 to
efefa33
Compare
|
build passing. Ready to merge. 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
The functions
matplotlib.scale.get_scale_docs()and its aliasmatplotlib.pyplot.get_scale_docs()are internal and should not be part of the public API.Probably nobody is using these anyway. However, I've introduced a deprecation first to be on the safe side.
A similar issue is
get_scale_names(), which is not addressed by the PR so far.get_scale_names()might actually have a value for the user, so it may be worth keeping and documenting. However, I would then at least remove it frompyplot.