8000 DOC: Sanitize some internal documentation links by ImportanceOfBeingErnest · Pull Request #11268 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

DOC: Sanitize some internal documentation links #11268

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

Conversation

ImportanceOfBeingErnest
Copy link
Member
@ImportanceOfBeingErnest ImportanceOfBeingErnest commented May 17, 2018

PR Summary

At some places in the documentation, links pointed to the online version of the docs instead of the internal version. E.g. http://matplotlib.org/whatever instead of whatever. This is undesired because the documentation should be self consistent and not accidentally point to a different version which may be available online.

This PR fixes those links. (I'm 99% sure, I found them all, but you can't ever be certain ;-))

PR Checklist

  • Code is PEP 8 compliant
  • Documentation is sphinx and numpydoc compliant

@anntzer
Copy link
Contributor
anntzer commented May 18, 2018

FWIW I much prefer links of the form given in https://matplotlib.org/devdocs/devel/documenting_mpl.html#referring-to-other-documents-and-sections (using :doc: + file instead of sphx_glr): they are both shorter and link to the file itself instead of an internal anchor that's just below the top.

@ImportanceOfBeingErnest
Copy link
Member Author

Ok, done.

@anntzer anntzer merged commit 4814755 into matplotlib:master May 28, 2018
@ImportanceOfBeingErnest ImportanceOfBeingErnest deleted the sanitize-some-doc-links branch May 28, 2018 15:52
@QuLogic QuLogic added this to the v3.0 milestone May 28, 2018
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.

4 participants
0