Skip to content

Commit 0502094

Browse files
committed
Modifications to style_guide.rst for review,
added link to Python docs
1 parent 239a305 commit 0502094

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

doc/devel/style_guide.rst

+11-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11

2-
===========
3-
Style Guide
4-
===========
2+
=========================
3+
Documentation Style Guide
4+
=========================
55

6-
This guide is for contributors to understand conventions and expectations for
7-
quality control of Matplotlib written content.
6+
This guide contains best practices for the language and formatting of Matplotlib
7+
documentation.
88

99
.. seealso::
1010

1111
For more information about contributing, see the :ref:`documenting-matplotlib`
1212
section.
1313

14-
Expository Language
14+
Expository language
1515
===================
1616

1717
For explanatory writing, the following guidelines are for clear and concise
@@ -259,9 +259,13 @@ Markdown tables and the csv-table directive are not accepted.
259259
+--------------------------------+----------------------------------------+
260260

261261

262-
Additional Resources
262+
Additional resources
263263
====================
264+
This style guide is not a comprehensive standard. For a more thorough
265+
reference of how to contribute to documentation, see the links below. These
266+
resources contain common best practices for writing documentation.
264267

268+
* `Python Developer's Guide <https://devguide.python.org/documenting/#documenting-python>`_
265269
* `Google Developer Style Guide <https://developers.google.com/style>`_
266270
* `IBM Style Guide <https://www.ibm.com/developerworks/library/styleguidelines/>`_
267271
* `Red Hat Style Guide <https://stylepedia.net/style/#grammar>`_

0 commit comments

Comments
 (0)