File tree 1 file changed +11
-7
lines changed
1 file changed +11
-7
lines changed Original file line number Diff line number Diff line change 1
1
2
- ===========
3
- Style Guide
4
- ===========
2
+ =========================
3
+ Documentation Style Guide
4
+ =========================
5
5
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 .
8
8
9
9
.. seealso ::
10
10
11
11
For more information about contributing, see the :ref: `documenting-matplotlib `
12
12
section.
13
13
14
- Expository Language
14
+ Expository language
15
15
===================
16
16
17
17
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.
259
259
+--------------------------------+----------------------------------------+
260
260
261
261
262
- Additional Resources
262
+ Additional resources
263
263
====================
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.
264
267
268
+ * `Python Developer's Guide <https://devguide.python.org/documenting/#documenting-python >`_
265
269
* `Google Developer Style Guide <https://developers.google.com/style >`_
266
270
* `IBM Style Guide <https://www.ibm.com/developerworks/library/styleguidelines/ >`_
267
271
* `Red Hat Style Guide <https://stylepedia.net/style/#grammar >`_
You can’t perform that action at this time.
0 commit comments