Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b6f3533

Browse files
committed
DOC: fix flake8 [ci doc]
1 parent b9cfbd0 commit b6f3533

File tree

10 files changed

+43
-27
lines changed

10 files changed

+43
-27
lines changed

.flake8

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,13 @@ per-file-ignores =
5858
galleries/tutorials/advanced/path_tutorial.py: E402
5959
galleries/tutorials/advanced/patheffects_guide.py: E402
6060
galleries/users_explain/artists/transforms_tutorial.py: E402, E501
61-
galleries/users_explain/colormaps.py: E501
61+
galleries/users_explain/colors/colormaps.py: E501
6262
galleries/users_explain/colors/colors.py: E402
6363
galleries/tutorials/intermediate/artists.py: E402
64-
galleries/users_explain/figure/constrainedlayout_guide.py: E402
64+
galleries/users_explain/axes/constrainedlayout_guide.py: E402
6565
galleries/users_explain/axes/legend_guide.py: E402
66-
galleries/users_explain/figure/tight_layout_guide.py: E402
67-
galleries/users_explain/animation_tutorial.py: E501
66+
galleries/users_explain/axes/tight_layout_guide.py: E402
67+
galleries/users_explain/animations/animations.py: E501
6868
galleries/tutorials/introductory/images.py: E501
6969
galleries/tutorials/introductory/pyplot.py: E402, E501
7070
galleries/users_explain/text/annotations.py: E402, E501
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
===========================
2+
Animations using Matplotlib
3+
===========================
4+
5+
Based on its plotting functionality, Matplotlib also provides an interface to
6+
generate animations using the `~matplotlib.animation` module. An
7+
animation is a sequence of frames where each frame corresponds to a plot on a
8+
`~matplotlib.figure.Figure`. This tutorial covers a general guideline on
9+
how to create such animations and the different options available.

galleries/tutorials/advanced/blitting.py renamed to galleries/users_explain/animations/blitting.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
"""
2+
.. redirected-from: /tutorials/advanced/blitting
3+
4+
.. _blitting:
5+
26
==================================
37
Faster rendering by using blitting
48
==================================

galleries/users_explain/artists/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,4 +195,4 @@ More details
195195
Concept: Automated color cycle <color_cycle>
196196
Concept: optimizing Artists for performance <performance>
197197
In Depth: understanding the extent keyword argument of imshow <imshow_extent>
198-
transforms_tutorial
198+
transforms_tutorial

galleries/users_explain/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ Using Matplotlib
1616
axis/index
1717
colors/index
1818
text/index
19-
animations
19+
animations/index

galleries/users_explain/text/fonts.py

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@
4545
- Hinting supported (virtual machine processes the "hints")
4646
* - Non-subsetted through Matplotlib
4747
- Subsetted via external module ttconv
48-
- Subsetted via external module `fontTools <https://github.com/fonttools/fonttools>`__
48+
- Subsetted via external module
49+
`fontTools <https://github.com/fonttools/fonttools>`__
4950
5051
.. note::
5152
@@ -58,9 +59,11 @@
5859
- Type 42 fonts (PS):
5960
6061
- PostScript wrapper around TrueType fonts
61-
- 42 is the `Answer to Life, the Universe, and Everything! <https://en.wikipedia.org/wiki/Answer_to_Life,_the_Universe,_and_Everything>`_
62-
- Matplotlib uses the external library `fontTools <https://github.com/fonttools/fonttools>`__
63-
to subset these types of fonts
62+
- 42 is the `Answer to Life, the Universe, and Everything!
63+
<https://en.wikipedia.org/wiki/Answer_to_Life,_the_Universe,_and_Everything>`_
64+
- Matplotlib uses the external library
65+
`fontTools <https://github.com/fonttools/fonttools>`__ to subset these types of
66+
fonts
6467
6568
- OpenType fonts:
6669
@@ -195,4 +198,4 @@
195198
196199
A majority of this work was done by Aitik Gupta supported by Google Summer of
197200
Code 2021.
198-
"""
201+
"""

lib/matplotlib/artist.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1067,7 +1067,7 @@ def set_animated(self, b):
10671067
using blitting.
10681068
10691069
See also `matplotlib.animation` and
1070-
:doc:`/tutorials/advanced/blitting`.
1070+
:ref:`blitting`.
10711071
10721072
Parameters
10731073
----------

lib/matplotlib/widgets.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ def __init__(self, ax, label, image=None,
187187
The color of the button when the mouse is over it.
188188
useblit : bool, default: True
189189
Use blitting for faster drawing if supported by the backend.
190-
See the tutorial :doc:`/tutorials/advanced/blitting` for details.
190+
See the tutorial :ref:`blitting` for details.
191191
"""
192192
super().__init__(ax)
193193

@@ -1028,7 +1028,7 @@ def __init__(self, ax, labels, actives=None, *, useblit=True,
10281028
same length as *labels*. If not given, all buttons are unchecked.
10291029
useblit : bool, default: True
10301030
Use blitting for faster drawing if supported by the backend.
1031-
See the tutorial :doc:`/tutorials/advanced/blitting` for details.
1031+
See the tutorial :ref:`blitting` for details.
10321032
label_props : dict, optional
10331033
Dictionary of `.Text` properties to be used for the labels.
10341034
@@ -1633,7 +1633,7 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,
16331633
specified here or in *radio_props*.
16341634
useblit : bool, default: True
16351635
Use blitting for faster drawing if supported by the backend.
1636-
See the tutorial :doc:`/tutorials/advanced/blitting` for details.
1636+
See the tutorial :ref:`blitting` for details.
16371637
label_props : dict or list of dict, optional
16381638
Dictionary of `.Text` properties to be used for the labels.
16391639
@@ -1952,7 +1952,7 @@ class Cursor(AxesWidget):
19521952
Whether to draw the vertical line.
19531953
useblit : bool, default: False
19541954
Use blitting for faster drawing if supported by the backend.
1955-
See the tutorial :doc:`/tutorials/advanced/blitting` for details.
1955+
See the tutorial :ref:`blitting` for details.
19561956
19571957
Other Parameters
19581958
----------------
@@ -2046,7 +2046,7 @@ class MultiCursor(Widget):
20462046
20472047
useblit : bool, default: True
20482048
Use blitting for faster drawing if supported by the backend.
2049-
See the tutorial :doc:`/tutorials/advanced/blitting`
2049+
See the tutorial :ref:`blitting`
20502050
for details.
20512051
20522052
horizOn : bool, default: False
@@ -2560,7 +2560,7 @@ def on_select(min: float, max: float) -> Any
25602560
25612561
useblit : bool, default: False
25622562
If True, use the backend-dependent blitting features for faster
2563-
canvas updates. See the tutorial :doc:`/tutorials/advanced/blitting`
2563+
canvas updates. See the tutorial :ref:`blitting`
25642564
for details.
25652565
25662566
props : dict, optional
@@ -2977,7 +2977,7 @@ class ToolLineHandles:
29772977
Additional line properties. See `matplotlib.lines.Line2D`.
29782978
useblit : bool, default: True
29792979
Whether to use blitting for faster drawing (if supported by the
2980-
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
2980+
backend). See the tutorial :ref:`blitting`
29812981
for details.
29822982
"""
29832983

@@ -3088,7 +3088,7 @@ class ToolHandles:
30883088
Additional marker properties. See `matplotlib.lines.Line2D`.
30893089
useblit : bool, default: True
30903090
Whether to use blitting for faster drawing (if supported by the
3091-
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
3091+
backend). See the tutorial :ref:`blitting`
30923092
for details.
30933093
"""
30943094

@@ -3165,7 +3165,7 @@ def onselect(eclick: MouseEvent, erelease: MouseEvent)
31653165
31663166
useblit : bool, default: False
31673167
Whether to use blitting for faster drawing (if supported by the
3168-
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
3168+
backend). See the tutorial :ref:`blitting`
31693169
for details.
31703170
31713171
props : dict, optional
@@ -3792,7 +3792,7 @@ def onselect(verts):
37923792
passed the vertices of the selected path.
37933793
useblit : bool, default: True
37943794
Whether to use blitting for faster drawing (if supported by the
3795-
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
3795+
backend). See the tutorial :ref:`blitting`
37963796
for details.
37973797
props : dict, optional
37983798
Properties with which the line is drawn, see `matplotlib.lines.Line2D`
@@ -3868,7 +3868,7 @@ class PolygonSelector(_SelectorWidget):
38683868
38693869
useblit : bool, default: False
38703870
Whether to use blitting for faster drawing (if supported by the
3871-
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
3871+
backend). See the tutorial :ref:`blitting`
38723872
for details.
38733873
38743874
props : dict, optional
@@ -4217,7 +4217,7 @@ class Lasso(AxesWidget):
42174217
passed the vertices of the selected path.
42184218
useblit : bool, default: True
42194219
Whether to use blitting for faster drawing (if supported by the
4220-
backend). See the tutorial :doc:`/tutorials/advanced/blitting`
4220+
backend). See the tutorial :ref:`blitting`
42214221
for details.
42224222
"""
42234223

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,10 @@ convention = "numpy"
118118
"galleries/users_explain/colors/colormaps.py" = ["E501"]
119119
"galleries/users_explain/colors/colors.py" = ["E402"]
120120
"galleries/tutorials/intermediate/artists.py" = ["E402"]
121-
"galleries/users_explain/figure/constrainedlayout_guide.py" = ["E402"]
121+
"galleries/users_explain/axes/constrainedlayout_guide.py" = ["E402"]
122122
"galleries/users_explain/axes/legend_guide.py" = ["E402"]
123-
"galleries/users_explain/figure/tight_layout_guide.py" = ["E402"]
124-
"galleries/users_explain/animation_tutorial.py" = ["E501"]
123+
"galleries/users_explain/axes/tight_layout_guide.py" = ["E402"]
124+
"galleries/users_explain/animations/animation.py" = ["E501"]
125125
"galleries/tutorials/introductory/images.py" = ["E501"]
126126
"galleries/tutorials/introductory/pyplot.py" = ["E402", "E501"]
127127
"galleries/users_explain/text/annotations.py" = ["E402", "E501"]

0 commit comments

Comments
 (0)