[gnuastro-commits] master 0ef27ab: Corrected argument list of gal_jpeg_read in book

[Mohammad Akhlaghi]

branch: master
commit 0ef27aba80d3318952852a0ddeaba153a9d5f965
Author: Mohammad Akhlaghi <address@hidden>
Commit: Mohammad Akhlaghi <address@hidden>

    Corrected argument list of gal_jpeg_read in book
    
    The list of JPEG functions in the book were initially copied from the TIFF
    section. But some things slipped through my fingers. The `dir' argument in
    `gal_jpeg_read' was wrong based on this and is now removed.
---
 doc/gnuastro.texi | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index b9210f4..605aae7 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -22145,10 +22145,11 @@ recognized suffixes are @code{.jpg}, @code{.JPG}, 
@code{.jpeg},
 @code{.JPEG}, @code{.jpe}, @code{.jif}, @code{.jfif} and @code{.jfi}.
 @end deftypefun
 
address@hidden {gal_data_t *} gal_jpeg_read (char @code{*filename}, size_t 
@code{dir}, size_t @code{minmapsize})
address@hidden {gal_data_t *} gal_jpeg_read (char @code{*filename}, size_t 
@code{minmapsize})
 Read the JPEG file @code{filename} and return the contents as
address@hidden If the directory's image contains multiple channels, the
-output will be a list (see @ref{List of gal_data_t}).
address@hidden If the directory's image contains multiple
+colors/channels, the output will be a list with one node per color/channel
+(see @ref{List of gal_data_t}).
 @end deftypefun
 
 @cindex JPEG compression quality