From 839f7e51dc46e25a74b4920d6b8b881666638b42 Mon Sep 17 00:00:00 2001 From: Larry Bradley Date: Thu, 8 Aug 2024 16:23:11 -0400 Subject: [PATCH] Put docstring in imperitive mood --- regions/_utils/examples.py | 2 +- regions/core/pixcoord.py | 2 +- regions/io/ds9/read.py | 5 +++++ regions/shapes/ellipse.py | 2 +- regions/shapes/rectangle.py | 2 +- 5 files changed, 9 insertions(+), 4 deletions(-) diff --git a/regions/_utils/examples.py b/regions/_utils/examples.py index a59db595..91d35ebc 100644 --- a/regions/_utils/examples.py +++ b/regions/_utils/examples.py @@ -102,7 +102,7 @@ def wcs(self): @lazyproperty def image(self): """ - Counts image (`~astropy.io.fits.ImageHDU`). + Return a "counts" image (`~astropy.io.fits.ImageHDU`). """ events = self.event_table skycoord = SkyCoord(events['GLON'], events['GLAT'], unit='deg', diff --git a/regions/core/pixcoord.py b/regions/core/pixcoord.py index 1cf6cb99..032378a0 100644 --- a/regions/core/pixcoord.py +++ b/regions/core/pixcoord.py @@ -129,7 +129,7 @@ def __sub__(self, other): def __eq__(self, other): """ - Checks whether ``other`` is `PixCoord` object and whether their + Check whether ``other`` is `PixCoord` object and whether their abscissa and ordinate values are equal using `np.testing.assert_allclose` with its default tolerance values. """ diff --git a/regions/io/ds9/read.py b/regions/io/ds9/read.py index b205f3ca..696f924e 100644 --- a/regions/io/ds9/read.py +++ b/regions/io/ds9/read.py @@ -622,7 +622,12 @@ def _define_region_params(region_type, shape, shape_params, frame=None): def _make_region(region_data): """ + Make a region object from the region data. + + Parameters + ---------- region_data : `_RegionData` instance + A `_RegionData` instance. """ try: # NOTE: returned shape can be different from region_data.shape diff --git a/regions/shapes/ellipse.py b/regions/shapes/ellipse.py index ba86a2c6..570c7f96 100644 --- a/regions/shapes/ellipse.py +++ b/regions/shapes/ellipse.py @@ -222,7 +222,7 @@ def _update_from_mpl_selector(self, *args, **kwargs): def as_mpl_selector(self, ax, active=True, sync=True, callback=None, **kwargs): """ - A matplotlib editable widget for this region + Return a matplotlib editable widget for this region (`matplotlib.widgets.EllipseSelector`). Parameters diff --git a/regions/shapes/rectangle.py b/regions/shapes/rectangle.py index 52605f34..87a8edfd 100644 --- a/regions/shapes/rectangle.py +++ b/regions/shapes/rectangle.py @@ -218,7 +218,7 @@ def _update_from_mpl_selector(self, *args, **kwargs): def as_mpl_selector(self, ax, active=True, sync=True, callback=None, **kwargs): """ - A matplotlib editable widget for the region + Return a matplotlib editable widget for the region (`matplotlib.widgets.RectangleSelector`). Parameters