Skip to content

Commit

Permalink
Minor update to MPL plotting docs section
Browse files Browse the repository at this point in the history
  • Loading branch information
cdeil committed Nov 30, 2016
1 parent 3396f60 commit 68b7478
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -819,7 +819,7 @@ Matplotlib plotting
===================

Some `~regions.PixelRegion` objects have an ``as_patch()`` method that returns an
equivalent `matplotlib.patches` object. For example :meth:`~regions.CirclePixelRegion.as_patch`
equivalent `matplotlib.patches` object. For example :meth:`regions.CirclePixelRegion.as_patch`
returns a `matplotlib.patches.Circle` object.

To draw a matplotlib patch object, add it to an `matplotlib.axes.Axes` object.
Expand Down Expand Up @@ -852,6 +852,9 @@ Here's a full example how to plot a `~regions.CirclePixelRegion` on an image.
.. plot:: plot_example_pix.py
:include-source:

The `~regions.RectanglePixelRegion` and `~regions.EllipsePixelRegion` docstrings also
contain plot examples.

`~regions.SkyRegion` objects currently don't have an ``as_patch()`` or ``plot()``
method. To plot them, convert them to a pixel region first:

Expand Down

0 comments on commit 68b7478

Please sign in to comment.