8000 Remove uninformative entries from glossary. by anntzer · Pull Request #14075 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

Remove uninformative entries from glossary. #14075

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 2 commits into from
May 4, 2019

Conversation

anntzer
Copy link
Contributor
@anntzer anntzer commented Apr 29, 2019

Remove some entries in the glossary which are only referred to once, in
the usage tutorial (note that the usage tutorial explitictly explains
the terms "raster" and "vector" graphics just before the renderer table.

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

Remove some entries in the glossary which are only referred to once, in
the usage tutorial (note that the usage tutorial explitictly explains
the terms "raster" and "vector" graphics just before the renderer table.
@timhoffm
Copy link
Member

I'm unsure about this. What is the criterion for "uninformative"? IMHO it doesn't hurt to have e.g. AGG in the glossary.

I cannot judge the real value of the glossary. It's difficult to find navigating the website and does only pop up in the search below code documentation (so is typically off-screen). OTOH why not leave it?

@anntzer
Copy link
Contributor Author
anntzer commented Apr 30, 2019

It's not as if the current entry for AGG really provides much information.

I was thinking of starting to use the glossary to document some matplotlib-specific jargon (e.g. the anatomy of matplotlib tutorial).

@timhoffm
Copy link
Member
timhoffm commented Apr 30, 2019
< 8000 /tr>

I was thinking of starting to use the glossary to document some matplotlib-specific jargon (e.g. the anatomy of matplotlib tutorial).

This is a very good idea. Something like this is really missing.

We should agree what should be contained in the glossary and what not. IMO image formats and python libraries can really go. I would still keep AGG, Cairo and FreeType for now as they may not be known to the average python user. In particular the former two are difficult to google.

@anntzer
Copy link
Contributor Author
anntzer commented Apr 30, 2019

feel free to push a partial revert, then.

@timhoffm
Copy link
Member
timhoffm commented May 4, 2019

My only contribution here is to undo some changes of the original commit. Since what goes in is only a subset of the original commit, I feel that I'm still legitimated for formal approval.

@timhoffm timhoffm merged commit 4236b57 into matplotlib:master May 4, 2019
@QuLogic QuLogic added this to the v3.2.0 milestone May 4, 2019
@anntzer 6EE8 anntzer deleted the glossary branch May 4, 2019 21:31
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
0