Making changes to docstrings and comments due to code review.

spacetelescope · Nov 21, 2024 · 104b8d8 · 104b8d8
1 parent b55c3b2
commit 104b8d8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/src/stcal/ramp_fitting/ols_fit.py b/src/stcal/ramp_fitting/ols_fit.py
@@ -46,10 +46,6 @@ def ols_ramp_fit_multi(ramp_data, buffsize, save_opt, readnoise_2d, gain_2d, wei
     gain_2d : ndarray
         gain for all pixels
 
-    algorithm : str
-        'OLS' specifies that ordinary least squares should be used;
-        'GLS' specifies that generalized least squares should be used.
-
     weighting : str
         'optimal' specifies that optimal weighting should be used;
          currently the only weighting supported.

diff --git a/src/stcal/ramp_fitting/src/slope_fitter.c b/src/stcal/ramp_fitting/src/slope_fitter.c
@@ -800,7 +800,10 @@ print_delim_char(char c, int len) {
     printf("\n");
 }
 
-/* Used for debugging to determine if a pixel is in a list */
+/* 
+ * Used to determine if a pixel is in a list.
+ * This is a debugging function.
+ */
 static inline int
 is_pix_in_list(struct ramp_data * rd, struct pixel_ramp * pr)
 {