[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnuastro-commits] master c0c49a3 2/2: Coorected missing argument in doc
From: |
Mohammad Akhlaghi |
Subject: |
[gnuastro-commits] master c0c49a3 2/2: Coorected missing argument in documentation of gal_fits_tab_write |
Date: |
Wed, 26 Dec 2018 16:02:36 -0500 (EST) |
branch: master
commit c0c49a3e1cf2aa9709b7befc82c6959ae162a4f8
Author: Mohammad Akhlaghi <address@hidden>
Commit: Mohammad Akhlaghi <address@hidden>
Coorected missing argument in documentation of gal_fits_tab_write
In the book, this function was missing the `extname' argument. This has
been corrected.
---
doc/gnuastro.texi | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 35f59af..c798e7e 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -25906,15 +25906,15 @@ linked list. It is recommended to use
@code{gal_table_read} for generic
reading of tables, see @ref{Table input output}.
@end deftypefun
address@hidden void gal_fits_tab_write (gal_data_t @code{*cols}, gal_list_str_t
@code{*comments}, int @code{tableformat}, char @code{*filename})
address@hidden void gal_fits_tab_write (gal_data_t @code{*cols}, gal_list_str_t
@code{*comments}, int @code{tableformat}, char @code{*filename}, char
@code{*extname})
Write the list of datasets in @code{cols} (see @ref{List of gal_data_t}) as
separate columns in a FITS table in @code{filename}. If @code{filename}
already exists then this function will write the table as a new extension
-after all existing ones. The format of the table (ASCII or binary) may be
-specified with the @code{tableformat} (see @ref{Table input output}). If
address@hidden, each node of the list of strings will be written as
-a @code{COMMENT} keywords in the output FITS file (see @ref{List of
-strings}.
+called @code{extname}, after all existing ones. The format of the table
+(ASCII or binary) may be specified with the @code{tableformat} (see
address@hidden input output}). If @code{comments!=NULL}, each node of the list
+of strings will be written as a @code{COMMENT} keywords in the output FITS
+file (see @ref{List of strings}.
This is a low-level function for tables. It is recommended to use
@code{gal_table_write} for generic writing of tables in a variety of