Merge pull request #718 from dirac-institute/doc_warning_fixes

Doc warning fixes
dirac-institute · Sep 20, 2024 · af0edaf · af0edaf
2 parents 5a5f0e8 + e0c30ed
commit af0edaf
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 11 deletions.
diff --git a/src/kbmod/reprojection.py b/src/kbmod/reprojection.py
@@ -34,7 +34,7 @@ def reproject_image(image, original_wcs, common_wcs):
         The WCS to reproject all the images into.
 
     Returns
-    ----------
+    -------
     new_image : `numpy.ndarray`
         The image data reprojected with a common `astropy.wcs.WCS`.
     footprint : `numpy.ndarray`
@@ -115,7 +115,7 @@ def reproject_work_unit(
         displayed or hidden.
 
     Returns
-    ----------
+    -------
     A `kbmod.WorkUnit` reprojected with a common `astropy.wcs.WCS`, or `None` in the case
     where `write_output` is set to True.
     """
@@ -186,8 +186,9 @@ def _reproject_work_unit(
         The base filename where output will be written if `write_output` is set to True.
     disable_show_progress : `bool`
             Whether or not to disable the `tqdm` show_progress bar.
+
     Returns
-    ----------
+    -------
     A `kbmod.WorkUnit` reprojected with a common `astropy.wcs.WCS`, or `None` in the case
     where `write_output` is set to True.
     """
@@ -344,7 +345,7 @@ def _reproject_work_unit_in_parallel(
             Whether or not to enable the `tqdm` show_progress bar.
 
     Returns
-    ----------
+    -------
     A `kbmod.WorkUnit` reprojected with a common `astropy.wcs.WCS`, or `None` in the case
     where `write_output` is set to True.
     """

diff --git a/src/kbmod/search/pydocs/stack_search_docs.h b/src/kbmod/search/pydocs/stack_search_docs.h
@@ -249,8 +249,8 @@ static const auto DOC_StackSearch_evaluate_single_trajectory = R"doc(
   Performs the evaluation of a single Trajectory object. Modifies the object
   in-place.
 
-  Note
-  ----
+  Notes
+  -----
   Runs on the CPU, but requires CUDA compiler.
 
   Parameters
@@ -262,8 +262,8 @@ static const auto DOC_StackSearch_evaluate_single_trajectory = R"doc(
 static const auto DOC_StackSearch_search_linear_trajectory = R"doc(
   Performs the evaluation of a linear trajectory in pixel space.
 
-  Note
-  ----
+  Notes
+  -----
   Runs on the CPU, but requires CUDA compiler.
 
   Parameters

diff --git a/src/kbmod/wcs_utils.py b/src/kbmod/wcs_utils.py
@@ -301,8 +301,8 @@ def calc_ecliptic_angle(wcs, center_pixel=(1000, 2000), step=12):
         with the image axes. Used to transform the specified search angles,
         with respect to the ecliptic, to search angles within the image.
 
-    Note
-    ----
+    Notes
+    -----
     It is not neccessary to calculate this angle for each image in an
     image set if they have all been warped to a common WCS.
     """
@@ -336,7 +336,7 @@ def extract_wcs_from_hdu_header(header):
         The header from which to read the data.
 
     Returns
-    --------
+    -------
     curr_wcs : `astropy.wcs.WCS`
         The WCS or None if it does not exist.
     """