Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4d27a68

Browse files
anntzeranntzer
committed
Update docs on docs.
Update PULL_REQUEST_TEMPLATE.md to emphasize markup specificities in RST (as opposed to md) regarding double/single backquotes and asterisks. In documenting_mpl.rst: - Various reformattings/line wrappings/rewordings. - Explicitly mark the highlighting language of each code block, as we have a mix of python/shell/rst (and emacs lisp). - Drop unneeded `:func:`/`:class:` markups. - Drop request to line wrap docstrings at 70 characters (in practice they are line-wrapped at 79 like normal Python sources). - Do not forbid spanned cells in tables, which recent Sphinxes handles just fine. In make.py: - Simplify argument parsing, slightly improving output of `./make.py --help`
1 parent 89183ba commit 4d27a68

File tree

3 files changed

+205
-167
lines changed

3 files changed

+205
-167
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ https://matplotlib.org/devdocs/devel/index.html-->
66
example "Raises ValueError on Non-Numeric Input to set_xlim". Please avoid
77
non-descriptive titles such as "Addresses issue #8576".-->
88

9+
<!--If you are contributing fixes to docstrings
10+
(which are very welcome!), please pay attention to
11+
http://matplotlib.org/devel/documenting_mpl.html#formatting. In particular,
12+
note the difference between using single backquotes, double backquotes, and
13+
asterisks in the markup.-->
14+
915
<!--If you are able to do so, please do not create the
1016
PR out of master, but out of a separate branch. See
1117
https://matplotlib.org/devel/gitwash/development_workflow.html for

0 commit comments

Comments
 (0)