Skip to content
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

Fix some link redirects in docs #17112

Merged
merged 1 commit into from Apr 13, 2020
Merged

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Apr 13, 2020

PR Summary

Found via shpinx linkcheck (see #5380). There are more, but I was too lazy to fix all now.

No need to backport because these are just redirects.

@timhoffm timhoffm added this to the v3.3.0 milestone Apr 13, 2020
@@ -444,17 +444,19 @@ def _create_tmp_config_or_cache_dir():
def _get_xdg_config_dir():
"""
Return the XDG configuration directory, according to the `XDG
base directory spec
<http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_.
base directory spec:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep the markup; below too.

Copy link
Member Author

@timhoffm timhoffm Apr 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be too long for our character limit. I didn't want to add a flake8 ignore for that. Since this is a private function, which is not rendered in the docs, I figured it's ok to remove the markup.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok but then at least remove the backquote before XDG, so that the thing stays correct markup (even if not rendered.
below too.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure.

Copy link
Contributor

@anntzer anntzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

postci

@@ -38,7 +38,7 @@ rendered properly in matplotlib's 2D rendering engine.
This problem will likely not be solved until OpenGL support is added to all of
the backends (patches are greatly welcomed). Until then, if you need complex
3D scenes, we recommend using
`MayaVi <http://code.enthought.com/projects/mayavi/documentation.php>`_.
`MayaVi <https://docs.enthought.com/mayavi/mayavi/>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you could move this link to out of line

use MayaVi_ ... using MayaVi_.

.. _MayaVi: https://...

to avoid duplicating it.

@tacaswell tacaswell merged commit 1fad1d2 into matplotlib:master Apr 13, 2020
@timhoffm timhoffm deleted the link-redirects branch April 13, 2020 19:28
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.

None yet

3 participants