Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: PolygonPixelRegion has no as_mpl_selector #500

Merged
merged 1 commit into from
Mar 31, 2023
Merged

DOC: PolygonPixelRegion has no as_mpl_selector #500

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/shapes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,8 +281,8 @@ to a :class:`~regions.SkyRegion`, call the
Selectors for Regions
---------------------

Several geometric regions (at this time, :class:`~regions.RectanglePixelRegion`,
:class:`~regions.EllipsePixelRegion` and :class:`~regions.PolygonPixelRegion`)
Several geometric regions (at this time, :class:`~regions.RectanglePixelRegion`
and :class:`~regions.EllipsePixelRegion`)
provide a method :meth:`~regions.RectanglePixelRegion.as_mpl_selector` to
create an interactive editable matplotlib widget that will be
connected to its parent region.
Expand Down Expand Up @@ -318,7 +318,7 @@ manipulation of this widget, with the following operations available:

Via the optional ``callback`` parameter this method can be passed a
custom function that will be called on every update of the region,
i.e. after every move or resize of the selector.
i.e., after every move or resize of the selector.
For an example of its usage see :ref:`Interactive Mask Control<interactive-masks>`.


Expand Down