Change documented "Optional" ScaleBase method to "Required" #3997
Conversation
This file contains 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
This is required, as the base class method raises NotImplementedError, so being documented as "Optional" is misleading.
|
And the function |
tacaswell
added a commit
that referenced
this pull request
Jan 19, 2015
DOC : Change documented "Optional" ScaleBase method to "Required"
tacaswell
added a commit
that referenced
this pull request
Jan 19, 2015
DOC : Change documented "Optional" ScaleBase method to "Required"
|
@ndevenish Thanks! Documentation PRs are always appreciated. back-ported as 3ab5edb |
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.
The
matplotlib.scale.ScaleBase.set_default_locators_and_formattersmethod is documented as optional in subclasses, but throws aNotImplementedError- and is actually called on subclass instances, so is not optional.This fixes the documentation to reflect this fact.