File tree 1 file changed +21
-0
lines changed
1 file changed +21
-0
lines changed Original file line number Diff line number Diff line change @@ -1115,6 +1115,27 @@ The current width limit (induced by *pydata-sphinx-theme*) is 720px, i.e.
1115
1115
``figsize=(7.2, ...) ``, or 896px if the page does not have subsections and
1116
1116
thus does not have the "On this page" navigation on the right-hand side.
1117
1117
1118
+
1119
+ Plot types guidelines
1120
+ ---------------------
1121
+
1122
+ The :ref: `plot_types ` gallery displays a selection of the common visualization
1123
+ techniques that are implemented in Matplotlib. The gallery is heavily curated and
1124
+ tightly scoped to the plotting methods on `matplotlib.axes.Axes `, therefore additions
1125
+ are generally discouraged.
1126
+
1127
+ Format
1128
+ ^^^^^^
1129
+ :title: Method signature with required arguments, e.g. ``plot(x, y) ``
1130
+ :description: In one sentence, describe the visualization that the method produces and
1131
+ link to the API documentation, e.g. *Draws a bar chart. See ~Axes.bar *.
1132
+ When necessary, add an additional sentence explaining the use case for
1133
+ this function vs a very similar one, e.g. stairs vs step.
1134
+ :plot: Use data with a self explanatory structure to illustrate the type of data this
1135
+ plotting method is typically used for.
1136
+ :code: The code should be about 5-10 lines with minimal customization. Plots in
1137
+ this gallery use the ``_mpl-gallery `` stylesheet for a uniform aesthetic.
1138
+
1118
1139
Miscellaneous
1119
1140
=============
1120
1141
You can’t perform that action at this time.
0 commit comments