Rename some helper classes in dviread. #9847
Closed
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
Currently, the existence of `matplotlib.dviread.Text` prevents one to write `\`~.Text\`` in the docs when referring to `matplotlib.text.Text` because sphinx does not know which of the two classes we are referring to. Rename `matplotlib.dviread.Text` to `_Text`, as there isn't (AFAICT) any reason to use it externally. Also renamed `_Page` and `_Box` for consistency. It turns out that the class deprecation machinery does not work for deprecating namedtuples, but attaching the deprecation warning to `__new__` instead of `__init__` fixes that.
ba4a9eb to
c1e03e6
Compare
jklymak
approved these changes
Nov 24, 2017
|
These are the return types from public functions, I am 👎 on making them private. Tacking 'DVI' on to the front or (if it makes sphinx happy) making the classes attributes on the In any case this will require docs. |
tacaswell
requested changes
Nov 25, 2017
6 tasks
|
Overridden by #9854. |
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.
Currently, the existence of
matplotlib.dviread.Textprevents one towrite
\~.Text`in the docs when referring tomatplotlib.text.Text`because sphinx does not know which of the two classes we are referring
to. (It seems clear to favor matplotlib.text.Text which is actually public
API.)
Rename
matplotlib.dviread.Textto_Text, as there isn't (AFAICT) anyreason to use it externally. Also renamed
_Pageand_Boxforconsistency.
It turns out that the class deprecation machinery does not work for
deprecating namedtuples, but attaching the deprecation warning to
__new__instead of__init__fixes that.PR Summary
PR Checklist