Thanks to visit codestin.com
Credit goes to github.com

Skip to content

removed glossary #18696

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 4 commits into from
Oct 13, 2020
Merged

removed glossary #18696

merged 4 commits into from
Oct 13, 2020

Conversation

maria-ilie
Copy link
Contributor

PR Summary

Issue #18491 - Removed glossary file and mention of glossary in doc\contents.rst . I checked with grep and there were no other places mentioning glossary.

PR Checklist

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

@jklymak jklymak requested a review from brunobeltran October 9, 2020 04:39
@jklymak jklymak added this to the v3.4.0 milestone Oct 9, 2020
@brunobeltran
Copy link
Contributor

One of the tutorials (I think introductory/usage? don't have time to look right now) uses the glossary. If those like 2 or 3 references get changed to links this will build.

As usual will have much more time over the weekend.

@brunobeltran
Copy link
Contributor

brunobeltran commented Oct 10, 2020

Hi @maria-ilie, thanks for taking care of this, and sorry for the terse response earlier.

As you can see below, circleci is failing to build the docs, which is because there are secretly references to it hiding in doc/tutorials/introductory/usage.rst, between lines 531--558-ish. The links in this table don't explicitly have the word glossary anywhere, but they don't have to! Since the glossary was the only place where a definition of those references appeared, then at doc build time that's what they were linked to. You can see how this works in the built docs if you want: https://matplotlib.org/tutorials/introductory/usage.html

As far as I can tell, this is the only file that uses these links so it would be more appropriate for the references to simply be added at the end of the file, as in the "external hyperlink targets" example here: https://docutils.sourceforge.io/docs/user/rst/quickref.html#external-hyperlink-targets

Let me know if you need any more pointers!

P.S. I recommend building the docs locally to make sure your changes worked correctly. If the make html command output ends in make: *** [Makefile:33: html] Error 1, then something needs to change for the docs to build correctly (grep for WARNING in the output to find it!)

Co-authored-by: Elliott Sales de Andrade <[email protected]>
@timhoffm timhoffm merged commit 8195e06 into matplotlib:master Oct 13, 2020
@timhoffm
Copy link
Member

@maria-ilie Thanks and congratulations on your first contribution to Matplotlib. We'd love to see you back!

@maria-ilie
Copy link
Contributor Author

Thanks @timhoffm and @brunobeltran for your advice and for taking the time to review this pull request!

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.

5 participants