Merge pull request #674 from meeseeksmachine/auto-backport-of-pr-668-…

…on-2.2 Backport PR #668 on branch 2.2 (Fix the unrendered code snippets in the docstrings)
sunpy · Apr 22, 2024 · 60632e6 · 60632e6
2 parents 2d89514 + 003894d
commit 60632e6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -209,6 +209,7 @@ ndcube/_version.py
 docs/_build
 docs/generated
 docs/api
+docs/sg_execution_times.rst
 examples/**/*.asdf
 examples/**/*.csv
 figure_test_images*

diff --git a/ndcube/ndcube.py b/ndcube/ndcube.py
@@ -217,11 +217,10 @@ def crop(self,
 
         Examples
         --------
-        An example of cropping a region of interest on the Sun from a 3-D image-time cube:
+        >>> # An example of cropping a region of interest on the Sun from a 3-D image-time cube
         >>> point1 = [SkyCoord(-50*u.deg, -40*u.deg, frame=frames.HeliographicStonyhurst), None]  # doctest: +SKIP
         >>> point2 = [SkyCoord(0*u.deg, -6*u.deg, frame=frames.HeliographicStonyhurst), None]  # doctest: +SKIP
         >>> NDCube.crop(point1, point2) # doctest: +SKIP
-
         """
 
     @abc.abstractmethod
@@ -267,7 +266,7 @@ def crop_by_values(self,
 
         Examples
         --------
-        An example of cropping a region of interest on the Sun from a 3-D image-time cube:
+        >>> # An example of cropping a region of interest on the Sun from a 3-D image-time cube
         >>> NDCube.crop_by_values((-600, -600, 0), (0, 0, 0), units=(u.arcsec, u.arcsec, u.s)) # doctest: +SKIP
         """