8000 add plot types guidance to docs · matplotlib/matplotlib@11c1a92 · GitHub
[go: up one dir, main page]

Skip to content

Commit 11c1a92

Browse files
committed
add plot types guidance to docs
1 parent 11b8e4e commit 11c1a92

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

doc/devel/document.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1115,6 +1115,28 @@ The current width limit (induced by *pydata-sphinx-theme*) is 720px, i.e.
11151115
``figsize=(7.2, ...)``, or 896px if the page does not have subsections and
11161116
thus does not have the "On this page" navigation on the right-hand side.
11171117

1118+
1119+
Plot types guidelines
1120+
---------------------
1121+
1122+
The :ref:`plot_types` gallery provides an overview of the types of visualizations that
1123+
Matplotlib provides out of the box, meaning that there is a high-level API for
1124+
generating each type of chart. Additions to this gallery are generally discouraged
1125+
because this gallery is heavily curated and tightly scoped to methods on
1126+
`matplotlib.axes.Axes`.
1127+
1128+
Format
1129+
^^^^^^
1130+
:title: Method signature with required arguments, e.g. ``plot(x, y)``
1131+
:description: In one sentence, describe the visualization that the method produces and
1132+
link to the API documentation, e.g. *Draws a bar chart. See ~Axes.bar*.
1133+
When necessary, add an additional sentence explaining the use case for
1134+
this function vs a very similar one, e.g. stairs vs step.
1135+
:plot: Use data with a self explanatory structure to illustrate the type of data this
1136+
plotting method is typically used for.
1137+
:code: The code should be about 5-10 lines with minimal customization. Plots in
1138+
this gallery use the ``_mpl-gallery`` stylesheet for a uniform aesthetic.
1139+
11181140
Miscellaneous
11191141
=============
11201142

0 commit comments

Comments
 (0)
0