Skip to content

Exclude dviread.Text from the documentation. #9854

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 28, 2017
Merged

Exclude dviread.Text from the documentation. #9854

merged 1 commit into from
Nov 28, 2017

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Nov 25, 2017

to make ~.Text unambiguously refer to matplotlib.text.Text.

Alternate to #9847.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@anntzer
Exclude dviread.Text from the documentation.
8ea94c5 
to make `~.Text` unambiguously refer to `matplotlib.text.Text`.
Kojoley
Kojoley approved these changes Nov 25, 2017
View reviewed changes
Copy link
Member

@Kojoley Kojoley left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. There is no reason why Page, Text and Box were on API docs, their description is useless.

P.S. Something bad happens to matplotlib.dviread.Dvi description, but it comes not from this change https://567-7439715-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/dviread.html

@anntzer
Copy link
Contributor Author

anntzer commented Nov 25, 2017

The "bad" thing happens because a functools.partial object with a big repr leaks into the API docs. (It was already the case before, not planning to fix it here.)

@tacaswell tacaswell added this to the v2.2 milestone Nov 25, 2017
jklymak
jklymak approved these changes Nov 28, 2017
View reviewed changes
Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@jklymak jklymak merged commit 124bbf2 into matplotlib:master Nov 28, 2017
@anntzer anntzer deleted the dviread-take-2 branch November 28, 2017 02:02
@anntzer anntzer mentioned this pull request Nov 28, 2017
Closed
6 tasks
@QuLogic QuLogic modified the milestones: needs sorting, v2.2.0 Feb 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jklymak jklymak jklymak approved these changes

@Kojoley Kojoley Kojoley approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v2.2.0
Development

Successfully merging this pull request may close these issues.
5 participants
@anntzer @jklymak @Kojoley @tacaswell @QuLogic