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

Skip to content

Commit 83fb034

Browse files
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 3ccaf2d commit 83fb034

File tree

3 files changed

+201
-166
lines changed

3 files changed

+201
-166
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ Please do not create the PR out of master, but out of a separate branch. -->
1010
example "Raises ValueError on Non-Numeric Input to set_xlim". Please avoid
1111
non-descriptive titles such as "Addresses issue #8576".-->
1212

13+
<!--If you are contributing fixes to docstrings
14+
(which are very welcome!), please pay attention to
15+
http://matplotlib.org/devel/documenting_mpl.html#formatting. In particular,
16+
note the difference between using single backquotes, double backquotes, and
17+
asterisks in the markup.-->
1318

1419
## PR Summary
1520

0 commit comments

Comments
 (0)