gnuastro-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[gnuastro-commits] master 7e19ffe: Table: improved documentation


From: Mohammad Akhlaghi
Subject: [gnuastro-commits] master 7e19ffe: Table: improved documentation
Date: Sun, 22 Mar 2020 11:36:19 -0400 (EDT)

branch: master
commit 7e19ffedebaef9f5aacbafc5721f420b074cfe29
Author: Mohammad Akhlaghi <address@hidden>
Commit: Mohammad Akhlaghi <address@hidden>

    Table: improved documentation
    
    The description of the new `--catcolumn' and `--catcolhdu' options was made
    more clear. I also noticed that Table's configuration file didn't end with
    a blank line. This isn't mandatory, but is a good practice, so a new empty
    line has been added in the end.
---
 bin/table/asttable.conf |  2 +-
 doc/gnuastro.texi       | 12 ++++++++----
 2 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/bin/table/asttable.conf b/bin/table/asttable.conf
index 2d75cfd..db9f1ae 100644
--- a/bin/table/asttable.conf
+++ b/bin/table/asttable.conf
@@ -21,4 +21,4 @@
 
 # Inputs
  wcshdu        1
- catcolhdu     1
\ No newline at end of file
+ catcolhdu     1
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index d5e09f6..db027f4 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -9283,13 +9283,17 @@ The FITS file name can be specified with 
@option{--wcsfile}.
 @item -F STR
 @itemx --catcolumn=STR
 Concatenate/add the columns of this option's value (a filename) with the main 
input table (keeping number of rows fixed).
-The concatenation is done after any column selection (for example with 
@option{--column}) or row selection (for example with @option{--range}) is 
applied to the input.
-Note that if the file given to this option is a FITS file, its necessary to 
also define the corresponding HDU/extension with @option{--catcolhdu}.
+The concatenation is done after any column selection (for example with 
@option{--column}) or row selection (for example with @option{--range}) is 
applied to the main input argument.
+
+If the file given to this option is a FITS file, its necessary to also define 
the corresponding HDU/extension with @option{--catcolhdu}.
+Also note that no column or row selection is applied to the table given to 
this topion.
+This option may be called multiple times (to add columns from more than one 
file into the final output), the columns will be added in the same order that 
this option is called.
 
 @item -u STR/INT
 @itemx --catcolhdu=STR/INT
-The HDU/extension of the FITS files that have been added.
-Same as @option{--hdu},Helps to choose Image extension for file given to 
@option{--catcolumn}.
+The HDU/extension of the FITS file(s) that have been added with 
@option{--catcolumn}.
+If @option{--catcolumn} is called more than once with more than one FITS file, 
its necessary to call this option more than once.
+The HDUs will be loaded in the same order as the FITS files given to 
@option{--catcolumn}.
 
 @item -O
 @itemx --colinfoinstdout



reply via email to

[Prev in Thread] Current Thread [Next in Thread]