Dokumentation Link and rename README #26994
Conversation
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
|
I dont get the error |
lib/matplotlib/tests/README.rst
Outdated
| @@ -4,5 +4,5 @@ About Matplotlib Testing Infrastructure | |||
| Information on the testing infrastructure is provided in | |||
| the Testing section of the Matplotlib Developers’ Guide: | |||
|
|
|||
| * https://matplotlib.org/devel/testing.html | |||
| * [Website](https://matplotlib.org/stable/devel/testing.html) | |||
There was a problem hiding this comment.
this page does not exist -> devel and stable are two versions of the same document
There was a problem hiding this comment.
https://matplotlib.org/devdocs/devel/testing.html is probably where this should be pointed.
|
matplotlib/lib/matplotlib/tests/meson.build Lines 97 to 104 in 6ba7d5f include this file in the documentation.
I am -0 on adding the extension, README files without an extension are not uncommon. The other thing that is concerning as that the rst reference is the source of https://matplotlib.org/devdocs/devel/coding_guide.html not the built page referenced. |
lib/matplotlib/tests/README.rst
Outdated
| @@ -4,5 +4,5 @@ About Matplotlib Testing Infrastructure | |||
| Information on the testing infrastructure is provided in | |||
| the Testing section of the Matplotlib Developers’ Guide: | |||
|
|
|||
| * https://matplotlib.org/devel/testing.html | |||
| * [Website](https://matplotlib.org/stable/devel/testing.html) | |||
| * <mpl_source_dir>/doc/devel/coding_guide.rst (equivalent, but in reST format) | |||
There was a problem hiding this comment.
Should probably point at https://github.com/matplotlib/matplotlib/blob/main/doc/devel/testing.rst
|
I want to point out that we currently have no consistent type and naming scheme for READMEs:
I did not check all their content, but at least some of the I don't think it's particularly important to have consistency here, but if we do want that, I'd be -0.5 on ReST. ReST has its merits for complex documents. But the READMEs are quite simple, not part of the doc build and often read as plain text. |
Not entirely true. The ones in the galleries are used by sphinx-gallery, and must be |
|
I think README is a misnomer for the gallery header files. I’ve opened sphinx-gallery/sphinx-gallery#1209 to see whether the can be changed to something more telling/accurate. But that’s orthogonal to this PR. |
| @@ -4,5 +4,5 @@ About Matplotlib Testing Infrastructure | |||
| Information on the testing infrastructure is provided in | |||
| the Testing section of the Matplotlib Developers’ Guide: | |||
|
|
|||
| * https://matplotlib.org/devel/testing.html | |||
| * <mpl_source_dir>/doc/devel/coding_guide.rst (equivalent, but in reST format) | |||
| - `Website <https://matplotlib.org/devdocs/devel/testing.html>`_ | |||
There was a problem hiding this comment.
I’m not convinced that ReST formatting is an advantage here. I assume that this file will be mostly opened as a source file in an editor, in which case plain URLs are easier to read than ReST formatted URLs.
Making the README an md file. Change the link to the right one and making it a hyperlink.