1313Pull request guidelines
1414***********************
1515
16- Pull requests (PRs) are the mechanism for contributing to Matplotlib's code and
17- documentation.
16+ ` Pull requests (PRs) on GitHub < https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests >`__
17+ are the mechanism for contributing to Matplotlib's code and documentation.
1818
1919It is recommended to check that your contribution complies with the following
2020rules before submitting a pull request:
2121
2222* If your pull request addresses an issue, please use the title to describe the
23- issue and mention the issue number in the pull request description to ensure
24- that a link is created to the original issue.
25-
26- * All public methods should have informative docstrings with sample usage when
27- appropriate. Use the ` numpy docstring standard
28- <https://numpydoc.readthedocs.io/en/latest/format.html> `_ .
23+ issue (e.g. "Add ability to plot timedeltas") and mention the issue number
24+ in the pull request description to ensure that a link is created to the
25+ original issue (e.g. "Closes #8869" or "Fixes #8869"). This will ensure the
26+ original issue mentioned is automatically closed when your PR is merged. See
27+ ` the GitHub documentation < https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue >`__
28+ for more details .
2929
3030* Formatting should follow the recommendations of PEP8 _, as enforced by
3131 flake8 _. You can check flake8 compliance from the command line with ::
@@ -45,6 +45,9 @@ rules before submitting a pull request:
4545 .. __ : https://github.com/psf/black/issues/148
4646 .. __ : https://github.com/psf/black/issues/1984
4747
48+ * All public methods should have informative docstrings with sample usage when
49+ appropriate. Use the :ref: `docstring standards <writing-docstrings >`.
50+
4851* Each high-level plotting function should have a simple example in the
4952 ``Example `` section of the docstring. This should be as simple as possible
5053 to demonstrate the method. More complex examples should go in the
0 commit comments