Privatize font_manager.JSONEncoder. #15082
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
... with the usual deprecation dance. End users can still use json_dump, which provides the necessary functionality (the docstring was slightly updated at the same time); the point is to hide the (lengthy) docs of JSONEncoder from the docs.
|
Semi-OT: I come more and more to the conclusion that private base classes are not a great idea. They try to simplify the API and hide irrelevant parts from the user. But in the end all abstractions are leaky, so the base class shines through. A quick search on the net did not yield any usage or discussion of private base classes. That doesn't of course help in the present case in which letting the deprecated class inherit from the privatized class seems indeed to be the simplest soloution. |
dstansby
approved these changes
Aug 22, 2019
timhoffm
approved these changes
Aug 22, 2019
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.
... with the usual deprecation dance.
End users can still use json_dump, which provides the necessary
functionality (the docstring was slightly updated at the same time); the
point is to hide the (lengthy) docs of JSONEncoder from the docs
(https://matplotlib.org/devdocs/api/font_manager_api.html#matplotlib.font_manager.JSONEncoder), where they are basically irrelevant.
I guess this picks up another "interesting" issue with missing_references.json: we get missing references when a class (here, the deprecated version of JSONEncoder) has private bases (another prominent case in matplotlib is Axes/_AxesBase), because sphinx tries to link to the base class when generating the inheritance diagram.
PR Summary
PR Checklist