Skip to content

Commit 8aa61af

Browse files
committed
Remove Axes sublist modification from docs
1 parent e572dd5 commit 8aa61af

File tree

2 files changed

+27
-30
lines changed

2 files changed

+27
-30
lines changed

examples/mplot3d/wire3d_animation_sgskip.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def generate(X, Y, phi):
3939
for phi in np.linspace(0, 180. / np.pi, 100):
4040
# If a line collection is already remove it before drawing.
4141
if wframe:
42-
ax.collections.remove(wframe)
42+
wframe.remove()
4343

4444
# Plot the new wireframe and pause briefly before continuing.
4545
Z = generate(X, Y, phi)

tutorials/intermediate/artists.py

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,11 @@ class in the Matplotlib API, and the one you will be working with most
7979
line, = ax.plot(t, s, color='blue', lw=2)
8080
8181
In this example, ``ax`` is the ``Axes`` instance created by the
82-
``fig.add_subplot`` call above (remember ``Subplot`` is just a
83-
subclass of ``Axes``) and when you call ``ax.plot``, it creates a
84-
``Line2D`` instance and adds it to the :attr:`Axes.lines
85-
<matplotlib.axes.Axes.lines>` list. In the interactive `IPython
86-
<https://ipython.org/>`_ session below, you can see that the
87-
``Axes.lines`` list is length one and contains the same line that was
88-
returned by the ``line, = ax.plot...`` call:
82+
``fig.add_subplot`` call above (remember ``Subplot`` is just a subclass of
83+
``Axes``) and when you call ``ax.plot``, it creates a ``Line2D`` instance and
84+
adds it to the ``Axes``. In the interactive `IPython <https://ipython.org/>`_
85+
session below, you can see that the ``Axes.lines`` list is length one and
86+
contains the same line that was returned by the ``line, = ax.plot...`` call:
8987
9088
.. sourcecode:: ipython
9189
@@ -97,11 +95,10 @@ class in the Matplotlib API, and the one you will be working with most
9795
9896
If you make subsequent calls to ``ax.plot`` (and the hold state is "on"
9997
which is the default) then additional lines will be added to the list.
100-
You can remove lines later simply by calling the list methods; either
101-
of these will work::
98+
You can remove a line later by calling its ``remove`` method::
10299
103-
del ax.lines[0]
104-
ax.lines.remove(line) # one or the other, not both!
100+
line = ax.lines[0]
101+
line.remove()
105102
106103
The Axes also has helper methods to configure and decorate the x-axis
107104
and y-axis tick, tick labels and axis labels::
@@ -386,11 +383,10 @@ class in the Matplotlib API, and the one you will be working with most
386383
# rect.set_facecolor('green')
387384
#
388385
# When you call a plotting method, e.g., the canonical
389-
# :meth:`~matplotlib.axes.Axes.plot` and pass in arrays or lists of
390-
# values, the method will create a :meth:`matplotlib.lines.Line2D`
391-
# instance, update the line with all the ``Line2D`` properties passed as
392-
# keyword arguments, add the line to the :attr:`Axes.lines
393-
# <matplotlib.axes.Axes.lines>` container, and returns it to you:
386+
# `~matplotlib.axes.Axes.plot` and pass in arrays or lists of values, the
387+
# method will create a `matplotlib.lines.Line2D` instance, update the line with
388+
# all the ``Line2D`` properties passed as keyword arguments, add the line to
389+
# the ``Axes``, and return it to you:
394390
#
395391
# .. sourcecode:: ipython
396392
#
@@ -423,19 +419,20 @@ class in the Matplotlib API, and the one you will be working with most
423419
# In [235]: print(len(ax.patches))
424420
# Out[235]: 50
425421
#
426-
# You should not add objects directly to the ``Axes.lines`` or
427-
# ``Axes.patches`` lists unless you know exactly what you are doing,
428-
# because the ``Axes`` needs to do a few things when it creates and adds
429-
# an object. It sets the figure and axes property of the ``Artist``, as
430-
# well as the default ``Axes`` transformation (unless a transformation
431-
# is set). It also inspects the data contained in the ``Artist`` to
432-
# update the data structures controlling auto-scaling, so that the view
433-
# limits can be adjusted to contain the plotted data. You can,
434-
# nonetheless, create objects yourself and add them directly to the
435-
# ``Axes`` using helper methods like
436-
# :meth:`~matplotlib.axes.Axes.add_line` and
437-
# :meth:`~matplotlib.axes.Axes.add_patch`. Here is an annotated
438-
# interactive session illustrating what is going on:
422+
# You should not add objects directly to the ``Axes.lines`` or ``Axes.patches``
423+
# lists, because the ``Axes`` needs to do a few things when it creates and adds
424+
# an object:
425+
#
426+
# - It sets the ``figure`` and ``axes`` property of the ``Artist``;
427+
# - It sets the default ``Axes`` transformation (unless one is already set);
428+
# - It inspects the data contained in the ``Artist`` to update the data
429+
# structures controlling auto-scaling, so that the view limits can be
430+
# adjusted to contain the plotted data.
431+
#
432+
# You can, nonetheless, create objects yourself and add them directly to the
433+
# ``Axes`` using helper methods like `~matplotlib.axes.Axes.add_line` and
434+
# `~matplotlib.axes.Axes.add_patch`. Here is an annotated interactive session
435+
# illustrating what is going on:
439436
#
440437
# .. sourcecode:: ipython
441438
#

0 commit comments

Comments
 (0)