Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
timhoffm merged 4 commits intomatplotlib:masterfrommaria-ilie:removing_glossary
Oct 13, 2020
Merged

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 (andpytest passes).
  • [N/A ] IsFlake 8 compliant (runflake8 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 shouldbuild without error).
  • [N/A ] Conforms to Matplotlib style conventions (installflake8-docstrings andpydocstyle<4 and runflake8 --docstring-convention=all).
  • [N/A ] New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A ] API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).

@jklymakjklymak added this to thev3.4.0 milestoneOct 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 commentedOct 10, 2020
edited
Loading

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 indoc/tutorials/introductory/usage.rst, between lines 531--558-ish. The links in this table don't explicitly have the wordglossary anywhere, but they don't have to! Since the glossary was the only place where a definition of thosereferences 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 recommendbuilding the docs locally to make sure your changes worked correctly. If themake html command output ends inmake: *** [Makefile:33: html] Error 1, then something needs to change for the docs to build correctly (grep forWARNING in the output to find it!)

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
@timhoffmtimhoffm merged commit8195e06 intomatplotlib:masterOct 13, 2020
@timhoffm
Copy link
Member

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

story645 and maria-ilie reacted with thumbs up emoji

@maria-ilie
Copy link
ContributorAuthor

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

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@QuLogicQuLogicQuLogic left review comments

@timhoffmtimhoffmtimhoffm approved these changes

@brunobeltranbrunobeltranAwaiting requested review from brunobeltran

Assignees
No one assigned
Projects
None yet
Milestone
v3.4.0
Development

Successfully merging this pull request may close these issues.

5 participants
@maria-ilie@brunobeltran@timhoffm@QuLogic@jklymak

[8]ページ先頭

©2009-2025 Movatter.jp