[gnuastro-commits] master 2b10e4c 2/2: Book: adding short options for std image/HDU in radial profile script

[Mohammad Akhlaghi]

branch: master
commit 2b10e4c6b83c6842bd3d90798715cc1fcbd7963d
Author: Raul Infante-Sainz <infantesainz@gmail.com>
Commit: Mohammad Akhlaghi <mohammad@akhlaghi.org>

    Book: adding short options for std image/HDU in radial profile script
    
    Until this commit, when specifying the standard deviation image/HDU for the
    radial profile script, the short options ('-i' and '-d'; added in the
    previous commit) were missing in the book.
    
    With this commit, the short option names have been added in the book. In
    the process, it was discovered that in some cases, the short and long named
    options (which sould start with '@item' and '@itemx', were both '@item';
    causing too much empty space in formatted prints). So with this commit, the
    long option name was changed to '@itemx'.
    
    Also, the previous commit fixed bug #61128, but this fact wasn't added to
    the NEWS file, so with this commit, we also added this bug as a fixed.
---
 NEWS              |  2 ++
 doc/gnuastro.texi | 10 ++++++----
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/NEWS b/NEWS
index 5cc54c5..62d4454 100644
--- a/NEWS
+++ b/NEWS
@@ -131,6 +131,8 @@ See the end of the file for license conditions.
               Vincenzo Testa and Zohreh Ghaffari.
   bug #61108: Plain text table metadata ignored when numeric data type was
               not understood, reported by Sepideh Eskandarlou.
+  bug #61128: Radial profile: --instd and --stdhdu error when space used
+              before value, found and fixed by Sepideh Eskandarlou.
   bug #61192: BuildProgram custom program linking problems on Debian-based
               OSs, reported by Raúl Infante-Sainz.
 
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 000891a..dd1f2bc 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -22254,7 +22254,7 @@ $ astmkcatalog -P | grep " sigmaclip "
 @end example
 
 @item -z FLT
-@item --zeropoint=FLT
+@itemx --zeropoint=FLT
 The Zeropoint of the input dataset.
 This is necessary when you request measurements like Magnitude, or Surface 
brightness.
 
@@ -22265,18 +22265,20 @@ Therefore if you set @option{--rmax=20} for example 
and @option{--oversample=5},
 Unless the object is heavily undersampled (the pixels are larger than the 
actual object), this method provides a much more accurate result and there are 
sufficient number of pixels to get the profile accurately.
 
 @item -u INT
-@item --undersample=INT
+@itemx --undersample=INT
 Undersample the input dataset by the number given to this option.
 This option is for considering larger apertures than the original pixel size 
(aperture size is equal to 1 pixel).
 For example, if a radial profile computed by default has 100 different radii 
(apertures of 1 pixel width), by considering @option{--undersample=2} the 
radial profile will be computed over apertures of 2 pixels, so the final radial 
profile will have 50 different radii.
 This option is good to measure over a larger number of pixels to improve the 
measurement.
 
-@item --instd=FLT/STR
+@item -i FLT/STR
+@itemx --instd=FLT/STR
 Sky standard deviation as a single number (FLT) or as the filename (STR) 
containing the image with the std value for each pixel (the HDU within the file 
should be given to the @option{--stdhdu} option mentioned below).
 This is only necessary when the requested measurement (value given to 
@option{--measure}) by MakeCatalog needs the Standard deviation (for example 
the signal-to-noise ratio or magnitude error).
 If your measurements don't require a standard deviation, it is best to ignore 
this option (because it will slow down the script).
 
-@item --stdhdu=STR
+@item -d INT/STR
+@itemx --stdhdu=INT/STR
 HDU/extension of the sky standard deviation image specified with 
@option{--instd}.
 
 @item -t STR