[gnuastro-commits] master 8e56612 2/3: Book: minor edits in newly added parts

[Mohammad Akhlaghi]

branch: master
commit 8e56612c21a9db5758fd4186f6d7318004d89ccb
Author: Mohammad Akhlaghi <address@hidden>
Commit: Mohammad Akhlaghi <address@hidden>

    Book: minor edits in newly added parts
    
    In order to make the text of the book more smooth, the text added in the
    previous commit was edited to fit into the same style as the rest of the
    book. In particular, "argument" was corrected to "option", along with a few
    minor style issues. Also, some index entries were added. A similar edit was
    done in the `--help' introduction.
    
    Finally, when building Gnuastro, I noticed that we hadn't included
    `astscript*' files as files to be ignored. So this was also done with this
    commit.
---
 .gitignore                  |  1 +
 bin/script/sort-by-night.in | 20 +++++++++-----------
 doc/gnuastro.texi           | 37 ++++++++++++++++++++-----------------
 3 files changed, 30 insertions(+), 28 deletions(-)

diff --git a/.gitignore b/.gitignore
index 3205af4..b0ce3cc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -92,6 +92,7 @@ configure
 .gnuastro
 astmkprof
 astheader
+astscript*
 astsegment
 runtest.sh
 astmknoise
diff --git a/bin/script/sort-by-night.in b/bin/script/sort-by-night.in
index 949449c..f65478a 100644
--- a/bin/script/sort-by-night.in
+++ b/bin/script/sort-by-night.in
@@ -58,17 +58,15 @@ Usage: $scriptname [OPTION] FITS-files
 
 This script is part of GNU Astronomy Utilities $version.
 
-This script will look into a HDU/extension for a header keyword in the given
-FITS files and interpret the value as a date. The inputs will be separated
-by "nights". The definition of "nights" is set with the agrument '--hour'.
-Be careful about differences in time zones! While the organization of images
-by date used to be in local time, the time expressed in '--key' is ussually
-defined in UTC (Universal Time Coordinate) time. It will then print a list
-of all the input files along with the following two columns: night number
-and file number in that night (sorted by time). With '--link' a symbolic
-link (one for each input) will be made with names including the night
-classifier. With '--copy' instead of a link, a copy of the inputs will be
-made.
+This script will look into a HDU/extension for a header keyword in the
+given FITS files and interpret the value as a date. The inputs will be
+separated by "night"s. The definition a "nights" is set with the '--hour'
+option (just note that the FITS time may be recorded in UTC, not local
+time)! It will then print a list of all the input files along with the
+following two columns: night number and file number in that night (sorted
+by time). With '--link' a symbolic link (one for each input) will be made
+with names including the night classifier. With '--copy' instead of a link,
+a copy of the inputs will be made.
 
 For more information, please run any of the following commands. In
 particular the first contains a very comprehensive explanation of this
diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index 20df7d8..0b797d4 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -10831,6 +10831,26 @@ The hour that defines the next ``night''. By default, 
all times before
 sub-hour value is necessary, it should be given in units of hours, for
 example @option{--hour=9.5} corresponds to 9:30a.m.
 
address@hidden
address@hidden
address@hidden Time zone
address@hidden UTC (Universal time coordinate)
address@hidden Universal time coordinate (UTC)
address@hidden with time zones:} the time that is recorded in
address@hidden may be in UTC (Universal Time Coordinate). However, the
+organization of the images taken during the night depends on the local
+time. It is possible to take this into account by setting the
address@hidden option to the local time in UTC.
+
+For example, consider a set of images taken in Auckland (New Zeland,
+UTC+12) during different nights. If you want to classify these images by
+night, you have to know at which time (in UTC time) the Sun rises (or any
+other separator/definition of a different night). In this particular
+example, you can use @option{--hour=21}. Because in Auckland, a night
+finishes (roughly) at the local time of 9:00, which corresponds to 21:00
+UTC.
address@hidden cartouche
+
 @item -l
 @itemx --link
 Create a symbolic link for each input FITS file. This option cannot be used
@@ -10879,23 +10899,6 @@ the files (in that directory) will all start with 
@file{img-}.
 @end table
 
 
address@hidden
address@hidden
address@hidden with time zones:} Time in @code{DATE-OBS} keyword in the
-header of the images is usually expressed in UTC (Universal Time Coordinate)
-time.  However, the organization of the images taken during the night used
-to be local time based. It is possible to take into account this time shift
-zone in the organization of the files with the @option{--hour} argument. For
-example, consider you have a set of images that were taken in Auckland (New
-Zeland, UTC+12) along different nights. If you want to organize these images
-by nights, you have to know at which time (in UTC time) Sun rises (or
-whatever consideration you need to make the definition of "different
-night"). In this particular example, you will set the argument
address@hidden, because in this city, sunrise happens (roughly) at 21h
-UTC time.
address@hidden cartouche
-
-