Skip to content
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.

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

Deprecate \stackrel. #12150

Merged
merged 1 commit into from Feb 22, 2019
Merged

Deprecate \stackrel. #12150

merged 1 commit into from Feb 22, 2019

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 18, 2018

Mathtext's \stackrel{a}{b} behaves subtly differently from latex's
\stackrel{a}{b}: mathtext makes a and b equal-sized whereas latex
makes a smaller than b (a is an "annotation" over b). Given
that we can already stack expressions using the (admittedly less
practical, but standard) \genfrac, just deprecate \stackrel instead of
maintaining our own latex-like dialect.

Also undeprecate passing obj_type to the cbook.deprecated decorator(!),
given that this PR has a good reason to use it... and while we're at it,
reorder the kwargs docs for cbook.deprecated and cbook.warn_deprecated
to match the order in the signature.

Again related to #12108 / #12128 (:mathmpl: still exists because mathtext is subtly different from latex).

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 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

@tacaswell tacaswell added this to the v3.1 milestone Sep 18, 2018
@anntzer anntzer force-pushed the stackrel branch 2 times, most recently from 90b3bc1 to cec36cd Compare October 5, 2018 14:17
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.

Fine w/ me. Doubt this is the most heavily used corner of the codebase...

@anntzer
Copy link
Contributor Author

anntzer commented Feb 10, 2019

rebased

Mathtext's \stackrel{a}{b} behaves subtly differently from latex's
\stackrel{a}{b}: mathtext makes `a` and `b` equal-sized whereas latex
makes `a` smaller than `b` (`a` is an "annotation" over `b`).  Given
that we can already stack expressions using the (admittedly less
practical, but standard) \genfrac, just deprecate \stackrel instead of
maintaining our own latex-like dialect.

Also undeprecate passing obj_type to the cbook.deprecated decorator(!),
given that this PR has a good reason to use it... and while we're at it,
reorder the kwargs docs for cbook.deprecated and cbook.warn_deprecated
to match the order in the signature.
Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Subject to CI pass.

Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Subject to CI pass.

@jklymak
Copy link
Member

jklymak commented Feb 22, 2019

CI failures unrelated...

@jklymak jklymak merged commit 977f415 into matplotlib:master Feb 22, 2019
@anntzer anntzer deleted the stackrel branch February 22, 2019 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants