Merge pull request #257 from cdeil/sphinx

Fix docstring formatting
astropy · May 16, 2019 · 79faa3c · 79faa3c
2 parents 75bc04d + ec40fb3
commit 79faa3c
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -7,5 +7,5 @@ About
 This is an astropy-affiliated package for region handling.
 
 * Code : https://github.com/astropy/regions
-* Docs : http://astropy-regions.readthedocs.io
+* Docs : https://astropy-regions.readthedocs.io
 
diff --git a/regions/shapes/ellipse.py b/regions/shapes/ellipse.py
@@ -186,8 +186,8 @@ def as_artist(self, origin=(0, 0), **kwargs):
         """
         Matplotlib patch object for this region (`matplotlib.patches.Ellipse`).
 
-        Parameters:
-        -----------
+        Parameters
+        ----------
         origin : array_like, optional
             The ``(x, y)`` pixel position of the origin of the displayed image.
             Default is (0, 0).

diff --git a/regions/shapes/line.py b/regions/shapes/line.py
@@ -103,8 +103,8 @@ def as_artist(self, origin=(0, 0), **kwargs):
         """
         Matplotlib patch object for this region (`matplotlib.patches.Arrow`).
 
-        Parameters:
-        -----------
+        Parameters
+        ----------
         origin : array_like, optional
             The ``(x, y)`` pixel position of the origin of the displayed image.
             Default is (0, 0).

diff --git a/regions/shapes/polygon.py b/regions/shapes/polygon.py
@@ -128,8 +128,8 @@ def as_artist(self, origin=(0, 0), **kwargs):
         """
         Matplotlib patch object for this region (`matplotlib.patches.Polygon`).
 
-        Parameters:
-        -----------
+        Parameters
+        ----------
         origin : array_like, optional
             The ``(x, y)`` pixel position of the origin of the displayed image.
             Default is (0, 0).

diff --git a/regions/shapes/rectangle.py b/regions/shapes/rectangle.py
@@ -171,8 +171,8 @@ def as_artist(self, origin=(0, 0), **kwargs):
         """
         Matplotlib patch object for this region (`matplotlib.patches.Rectangle`).
 
-        Parameters:
-        -----------
+        Parameters
+        ----------
         origin : array_like, optional
             The ``(x, y)`` pixel position of the origin of the displayed image.
             Default is (0, 0).