Skip to content

Commit 0d489ea

Browse files
tacaswelltacaswell
authored
Merge pull request #19845 from meeseeksmachine/auto-backport-of-pr-19788-on-v3.4.1-doc
Backport PR #19788 on branch v3.4.1-doc (Reformat references)
2 parents c6d08c6 + 84409eb commit 0d489ea

File tree

118 files changed

+856
-1386
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+856
-1386
lines changed

‎examples/color/color_by_yvalue.py

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,9 @@
2424

2525
#############################################################################
2626
#
27-
# ------------
27+
# .. admonition:: References
2828
#
29-
# References
30-
# """"""""""
29+
# The use of the following functions, methods, classes and modules is shown
30+
# in this example:
3131
#
32-
# The use of the following functions, methods, classes and modules is shown
33-
# in this example:
34-
35-
import matplotlib
36-
matplotlib.axes.Axes.plot
37-
matplotlib.pyplot.plot
32+
# - `matplotlib.axes.Axes.plot` / `matplotlib.pyplot.plot`

‎examples/color/color_cycle_default.py

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,18 +42,12 @@
4242

4343
#############################################################################
4444
#
45-
# ------------
45+
# .. admonition:: References
4646
#
47-
# References
48-
# """"""""""
47+
# The use of the following functions, methods, classes and modules is shown
48+
# in this example:
4949
#
50-
# The use of the following functions, methods, classes and modules is shown
51-
# in this example:
52-
53-
import matplotlib
54-
matplotlib.axes.Axes.axhline
55-
matplotlib.axes.Axes.axvline
56-
matplotlib.pyplot.axhline
57-
matplotlib.pyplot.axvline
58-
matplotlib.axes.Axes.set_facecolor
59-
matplotlib.figure.Figure.suptitle
50+
# - `matplotlib.axes.Axes.axhline` / `matplotlib.pyplot.axhline`
51+
# - `matplotlib.axes.Axes.axvline` / `matplotlib.pyplot.axvline`
52+
# - `matplotlib.axes.Axes.set_facecolor`
53+
# - `matplotlib.figure.Figure.suptitle`

‎examples/color/color_demo.py

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -63,19 +63,15 @@
6363

6464
#############################################################################
6565
#
66-
# ------------
66+
# .. admonition:: References
6767
#
68-
# References
69-
# """"""""""
68+
# The use of the following functions, methods, classes and modules is shown
69+
# in this example:
7070
#
71-
# The use of the following functions, methods, classes and modules is shown
72-
# in this example:
73-
74-
import matplotlib
75-
matplotlib.colors
76-
matplotlib.axes.Axes.plot
77-
matplotlib.axes.Axes.set_facecolor
78-
matplotlib.axes.Axes.set_title
79-
matplotlib.axes.Axes.set_xlabel
80-
matplotlib.axes.Axes.set_ylabel
81-
matplotlib.axes.Axes.tick_params
71+
# - `matplotlib.colors`
72+
# - `matplotlib.axes.Axes.plot`
73+
# - `matplotlib.axes.Axes.set_facecolor`
74+
# - `matplotlib.axes.Axes.set_title`
75+
# - `matplotlib.axes.Axes.set_xlabel`
76+
# - `matplotlib.axes.Axes.set_ylabel`
77+
# - `matplotlib.axes.Axes.tick_params`

‎examples/color/colorbar_basics.py

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,12 @@
4747

4848
#############################################################################
4949
#
50-
# ------------
50+
# .. admonition:: References
5151
#
52-
# References
53-
# """"""""""
52+
# The use of the following functions, methods, classes and modules is shown
53+
# in this example:
5454
#
55-
# The use of the following functions, methods, classes and modules is shown
56-
# in this example:
57-
58-
import matplotlib
59-
import matplotlib.colorbar
60-
matplotlib.axes.Axes.imshow
61-
matplotlib.pyplot.imshow
62-
matplotlib.figure.Figure.colorbar
63-
matplotlib.pyplot.colorbar
64-
matplotlib.colorbar.Colorbar.minorticks_on
65-
matplotlib.colorbar.Colorbar.minorticks_off
55+
# - `matplotlib.axes.Axes.imshow` / `matplotlib.pyplot.imshow`
56+
# - `matplotlib.figure.Figure.colorbar` / `matplotlib.pyplot.colorbar`
57+
# - `matplotlib.colorbar.ColorbarBase.minorticks_on`
58+
# - `matplotlib.colorbar.ColorbarBase.minorticks_off`

‎examples/color/colormap_reference.py

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,12 @@ def plot_color_gradients(cmap_category, cmap_list):
7171

7272
#############################################################################
7373
#
74-
# ------------
74+
# .. admonition:: References
7575
#
76-
# References
77-
# """"""""""
76+
# The use of the following functions, methods, classes and modules is shown
77+
# in this example:
7878
#
79-
# The use of the following functions, methods, classes and modules is shown
80-
# in this example:
81-
82-
import matplotlib
83-
matplotlib.colors
84-
matplotlib.axes.Axes.imshow
85-
matplotlib.figure.Figure.text
86-
matplotlib.axes.Axes.set_axis_off
79+
# - `matplotlib.colors`
80+
# - `matplotlib.axes.Axes.imshow`
81+
# - `matplotlib.figure.Figure.text`
82+
# - `matplotlib.axes.Axes.set_axis_off`

‎examples/color/custom_cmap.py

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -224,23 +224,16 @@
224224

225225
#############################################################################
226226
#
227-
# ------------
227+
# .. admonition:: References
228228
#
229-
# References
230-
# """"""""""
229+
# The use of the following functions, methods, classes and modules is shown
230+
# in this example:
231231
#
232-
# The use of the following functions, methods, classes and modules is shown
233-
# in this example:
234-
235-
import matplotlib
236-
matplotlib.axes.Axes.imshow
237-
matplotlib.pyplot.imshow
238-
matplotlib.figure.Figure.colorbar
239-
matplotlib.pyplot.colorbar
240-
matplotlib.colors
241-
matplotlib.colors.LinearSegmentedColormap
242-
matplotlib.colors.LinearSegmentedColormap.from_list
243-
matplotlib.cm
244-
matplotlib.cm.ScalarMappable.set_cmap
245-
matplotlib.pyplot.register_cmap
246-
matplotlib.cm.register_cmap
232+
# - `matplotlib.axes.Axes.imshow` / `matplotlib.pyplot.imshow`
233+
# - `matplotlib.figure.Figure.colorbar` / `matplotlib.pyplot.colorbar`
234+
# - `matplotlib.colors`
235+
# - `matplotlib.colors.LinearSegmentedColormap`
236+
# - `matplotlib.colors.LinearSegmentedColormap.from_list`
237+
# - `matplotlib.cm`
238+
# - `matplotlib.cm.ScalarMappable.set_cmap`
239+
# - `matplotlib.cm.register_cmap`

‎examples/color/named_colors.py

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -90,19 +90,15 @@ def plot_colortable(colors, title, sort_colors=True, emptycols=0):
9090

9191
#############################################################################
9292
#
93-
# ------------
93+
# .. admonition:: References
9494
#
95-
# References
96-
# """"""""""
95+
# The use of the following functions, methods, classes and modules is shown
96+
# in this example:
9797
#
98-
# The use of the following functions, methods, classes and modules is shown
99-
# in this example:
100-
101-
import matplotlib
102-
matplotlib.colors
103-
matplotlib.colors.rgb_to_hsv
104-
matplotlib.colors.to_rgba
105-
matplotlib.figure.Figure.get_size_inches
106-
matplotlib.figure.Figure.subplots_adjust
107-
matplotlib.axes.Axes.text
108-
matplotlib.patches.Rectangle
98+
# - `matplotlib.colors`
99+
# - `matplotlib.colors.rgb_to_hsv`
100+
# - `matplotlib.colors.to_rgba`
101+
# - `matplotlib.figure.Figure.get_size_inches`
102+
# - `matplotlib.figure.Figure.subplots_adjust`
103+
# - `matplotlib.axes.Axes.text`
104+
# - `matplotlib.patches.Rectangle`

‎examples/images_contours_and_fields/demo_bboximage.py

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,12 @@
7171

7272
#############################################################################
7373
#
74-
# ------------
74+
# .. admonition:: References
7575
#
76-
# References
77-
# """"""""""
76+
# The use of the following functions, methods, classes and modules is shown
77+
# in this example:
7878
#
79-
# The use of the following functions, methods, classes and modules is shown
80-
# in this example:
81-
82-
import matplotlib
83-
matplotlib.image.BboxImage
84-
matplotlib.transforms.Bbox
85-
matplotlib.transforms.TransformedBbox
86-
matplotlib.text.Text
79+
# - `matplotlib.image.BboxImage`
80+
# - `matplotlib.transforms.Bbox`
81+
# - `matplotlib.transforms.TransformedBbox`
82+
# - `matplotlib.text.Text`

‎examples/images_contours_and_fields/figimage_demo.py

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
88
"""
99
import numpy as np
10-
import matplotlib
1110
import matplotlib.pyplot as plt
1211

1312

@@ -22,14 +21,10 @@
2221

2322
#############################################################################
2423
#
25-
# ------------
24+
# .. admonition:: References
2625
#
27-
# References
28-
# """"""""""
26+
# The use of the following functions, methods, classes and modules is shown
27+
# in this example:
2928
#
30-
# The use of the following functions, methods, classes and modules is shown
31-
# in this example:
32-
33-
matplotlib.figure.Figure
34-
matplotlib.figure.Figure.figimage
35-
matplotlib.pyplot.figimage
29+
# - `matplotlib.figure.Figure`
30+
# - `matplotlib.figure.Figure.figimage` / `matplotlib.pyplot.figimage`

‎examples/images_contours_and_fields/image_zcoord.py

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,10 @@ def format_coord(x, y):
3838

3939
#############################################################################
4040
#
41-
# ------------
41+
# .. admonition:: References
4242
#
43-
# References
44-
# """"""""""
43+
# The use of the following functions, methods, classes and modules is shown
44+
# in this example:
4545
#
46-
# The use of the following functions, methods, classes and modules is shown
47-
# in this example:
48-
49-
import matplotlib
50-
matplotlib.axes.Axes.format_coord
51-
matplotlib.axes.Axes.imshow
46+
# - `matplotlib.axes.Axes.format_coord`
47+
# - `matplotlib.axes.Axes.imshow`

‎examples/images_contours_and_fields/tricontour_smooth_delaunay.py

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -142,22 +142,15 @@ def experiment_res(x, y):
142142

143143
#############################################################################
144144
#
145-
# ------------
145+
# .. admonition:: References
146146
#
147-
# References
148-
# """"""""""
147+
# The use of the following functions, methods, classes and modules is shown
148+
# in this example:
149149
#
150-
# The use of the following functions, methods, classes and modules is shown
151-
# in this example:
152-
153-
import matplotlib
154-
matplotlib.axes.Axes.tricontour
155-
matplotlib.pyplot.tricontour
156-
matplotlib.axes.Axes.tricontourf
157-
matplotlib.pyplot.tricontourf
158-
matplotlib.axes.Axes.triplot
159-
matplotlib.pyplot.triplot
160-
matplotlib.tri
161-
matplotlib.tri.Triangulation
162-
matplotlib.tri.TriAnalyzer
163-
matplotlib.tri.UniformTriRefiner
150+
# - `matplotlib.axes.Axes.tricontour` / `matplotlib.pyplot.tricontour`
151+
# - `matplotlib.axes.Axes.tricontourf` / `matplotlib.pyplot.tricontourf`
152+
# - `matplotlib.axes.Axes.triplot` / `matplotlib.pyplot.triplot`
153+
# - `matplotlib.tri`
154+
# - `matplotlib.tri.Triangulation`
155+
# - `matplotlib.tri.TriAnalyzer`
156+
# - `matplotlib.tri.UniformTriRefiner`

‎examples/images_contours_and_fields/tricontour_smooth_user.py

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -78,19 +78,13 @@ def function_z(x, y):
7878

7979
#############################################################################
8080
#
81-
# ------------
81+
# .. admonition:: References
8282
#
83-
# References
84-
# """"""""""
83+
# The use of the following functions, methods, classes and modules is shown
84+
# in this example:
8585
#
86-
# The use of the following functions, methods, classes and modules is shown
87-
# in this example:
88-
89-
import matplotlib
90-
matplotlib.axes.Axes.tricontour
91-
matplotlib.pyplot.tricontour
92-
matplotlib.axes.Axes.tricontourf
93-
matplotlib.pyplot.tricontourf
94-
matplotlib.tri
95-
matplotlib.tri.Triangulation
96-
matplotlib.tri.UniformTriRefiner
86+
# - `matplotlib.axes.Axes.tricontour` / `matplotlib.pyplot.tricontour`
87+
# - `matplotlib.axes.Axes.tricontourf` / `matplotlib.pyplot.tricontourf`
88+
# - `matplotlib.tri`
89+
# - `matplotlib.tri.Triangulation`
90+
# - `matplotlib.tri.UniformTriRefiner`

‎examples/images_contours_and_fields/trigradient_demo.py

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -89,23 +89,16 @@ def dipole_potential(x, y):
8989

9090
#############################################################################
9191
#
92-
# ------------
92+
# .. admonition:: References
9393
#
94-
# References
95-
# """"""""""
94+
# The use of the following functions, methods, classes and modules is shown
95+
# in this example:
9696
#
97-
# The use of the following functions, methods, classes and modules is shown
98-
# in this example:
99-
100-
import matplotlib
101-
matplotlib.axes.Axes.tricontour
102-
matplotlib.pyplot.tricontour
103-
matplotlib.axes.Axes.triplot
104-
matplotlib.pyplot.triplot
105-
matplotlib.tri
106-
matplotlib.tri.Triangulation
107-
matplotlib.tri.CubicTriInterpolator
108-
matplotlib.tri.CubicTriInterpolator.gradient
109-
matplotlib.tri.UniformTriRefiner
110-
matplotlib.axes.Axes.quiver
111-
matplotlib.pyplot.quiver
97+
# - `matplotlib.axes.Axes.tricontour` / `matplotlib.pyplot.tricontour`
98+
# - `matplotlib.axes.Axes.triplot` / `matplotlib.pyplot.triplot`
99+
# - `matplotlib.tri`
100+
# - `matplotlib.tri.Triangulation`
101+
# - `matplotlib.tri.CubicTriInterpolator`
102+
# - `matplotlib.tri.CubicTriInterpolator.gradient`
103+
# - `matplotlib.tri.UniformTriRefiner`
104+
# - `matplotlib.axes.Axes.quiver` / `matplotlib.pyplot.quiver`

‎examples/images_contours_and_fields/triinterp_demo.py

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -61,24 +61,16 @@
6161

6262
#############################################################################
6363
#
64-
# ------------
64+
# .. admonition:: References
6565
#
66-
# References
67-
# """"""""""
66+
# The use of the following functions, methods, classes and modules is shown
67+
# in this example:
6868
#
69-
# The use of the following functions, methods, classes and modules is shown
70-
# in this example:
71-
72-
import matplotlib
73-
matplotlib.axes.Axes.tricontourf
74-
matplotlib.pyplot.tricontourf
75-
matplotlib.axes.Axes.triplot
76-
matplotlib.pyplot.triplot
77-
matplotlib.axes.Axes.contourf
78-
matplotlib.pyplot.contourf
79-
matplotlib.axes.Axes.plot
80-
matplotlib.pyplot.plot
81-
matplotlib.tri
82-
matplotlib.tri.LinearTriInterpolator
83-
matplotlib.tri.CubicTriInterpolator
84-
matplotlib.tri.Triangulation
69+
# - `matplotlib.axes.Axes.tricontourf` / `matplotlib.pyplot.tricontourf`
70+
# - `matplotlib.axes.Axes.triplot` / `matplotlib.pyplot.triplot`
71+
# - `matplotlib.axes.Axes.contourf` / `matplotlib.pyplot.contourf`
72+
# - `matplotlib.axes.Axes.plot` / `matplotlib.pyplot.plot`
73+
# - `matplotlib.tri`
74+
# - `matplotlib.tri.LinearTriInterpolator`
75+
# - `matplotlib.tri.CubicTriInterpolator`
76+
# - `matplotlib.tri.Triangulation`

0 commit comments

Comments
 (0)