Merge pull request #1 from PDLPorters/fitgauss_err_codes

Document returned error codes in fitgauss1d

Author: mohawk2

Gaussian/gaussian.pd

@@ -61,6 +61,20 @@ estimate of the FWHM is the length of the ndarray/3, so it might fail
 if the ndarray is too long. (This is non-robust anyway). Most data
 does just fine and this is a good default gaussian fitter.
 
+The values of the error code $err correspond to:
+
+=over 4
+
+=item 0: successful fit
+
+=item 1: internal problem with memory allocation
+
+=item 2: insufficient number of data points
+
+=item 3: fit did not converge
+
+=back
+
 SEE ALSO: fitgauss1dr() for fitting radial gaussians
 
 =head2 fitgauss1dr
@@ -92,6 +106,20 @@ estimate of the FWHM is the length of the ndarray/3, so it might fail
 if the ndarray is too long. (This is non-robust anyway). Most data
 does just fine and this is a good default gaussian fitter.
 
+The values of the error code $err correspond to:
+
+=over 4
+
+=item 0: successful fit
+
+=item 1: internal problem with memory allocation
+
+=item 2: insufficient number of data points
+
+=item 3: fit did not converge
+
+=back
+
 SEE ALSO: fitgauss1d() to fit centre as well.
 
 =cut