Skip to content

Rename symbol_name to glyph_name where appropriate. #20974

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

Merged
merged 1 commit into from
Sep 2, 2021

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 2, 2021

When referring to a font glyph, "glyph name" is standard terminology
(e.g. FT_Get_Glyph_Name or Adobe docs); additionally there is a separate
concept of "symbol_name" used by the mathtext parser which has a
different meaning (\foo commands referring to TeX symbol names), so
let's not confuse them.

symbol_name is kept in the mathtext SimpleNamespaces for backcompat
(changing the SimpleNamespace to a proper class with a property handling
the deprecation is not worth the work).

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

When referring to a font glyph, "glyph name" is standard terminology
(e.g. FT_Get_Glyph_Name or Adobe docs); additionally there is a separate
concept of "symbol_name" used by the mathtext parser which has a
different meaning (`\foo` commands referring to TeX symbol names), so
let's not confuse them.

symbol_name is kept in the mathtext SimpleNamespaces for backcompat
(changing the SimpleNamespace to a proper class with a property handling
the deprecation is not worth the work).
@QuLogic QuLogic added this to the v3.6.0 milestone Sep 2, 2021
@QuLogic QuLogic merged commit 5656d11 into matplotlib:master Sep 2, 2021
@anntzer anntzer deleted the gn branch September 3, 2021 06:54
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
Rename symbol_name to glyph_name where appropriate.
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.

3 participants