clarify fit docstring

ajwheeler · Oct 11, 2024 · 4926f67 · 4926f67
1 parent 46c9f8e
commit 4926f67
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/fit.jl b/src/fit.jl
@@ -228,6 +228,10 @@ values are used.
   - `postprocess` can be used to arbitrarilly transform the synthesized (and LSF-convolved) spectrum
     before calculating the chi2.  It should take the form `postprocess(flux, data, err)` and write
     its changes in-place to the flux array.
+  - `LSF_matrix`: this can be provedided along with `synthesis_wls` in place of specifying `R` if
+    you have a precomputed custom LSF matrix.
+  - `synthesis_wls`: see `LSF_matrix` above. This can be a Korg.Wavelengths object or any arguments
+    that can be passed to its constructor, e.g. a range or vector of ranges. Wavelengths are in Å.
   - Any additional keyword arguments will be passed to [`Korg.synthesize`](@ref) when synthesizing the
     spectra for the fit.