Put docstring in imperitive mood

astropy · Aug 8, 2024 · 839f7e5 · 839f7e5
1 parent 52c18dc
commit 839f7e5
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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