[gnuastro-commits] master eb4dfde3 3/3: Book: example in commit guide lines now fits in PDF page width

[Mohammad Akhlaghi]

branch: master
commit eb4dfde3a7b89f451c30a8cc73e19ecb9503c195
Author: Sepideh Eskandarlou <sepideh.eskandarlou@gmail.com>
Commit: Mohammad Akhlaghi <mohammad@akhlaghi.org>

    Book: example in commit guide lines now fits in PDF page width
    
    Until now, the example of the commit body (within the commit guidelines
    section) did not fit with the page size and it was out of the normal book
    page size. Because instead of writing 75 characters in each line, a
    sentence was written in each line.
    
    With this commit, the example commit message has been adjusted to have a
    fixed line width of at most 73 characters (75 would also go beyond the text
    limits in the PDF).
---
 doc/gnuastro.texi | 31 +++++++++++++++++++------------
 1 file changed, 19 insertions(+), 12 deletions(-)

diff --git a/doc/gnuastro.texi b/doc/gnuastro.texi
index ebe0ba94..b7060747 100644
--- a/doc/gnuastro.texi
+++ b/doc/gnuastro.texi
@@ -44675,20 +44675,27 @@ After reading this, please run @command{git log} on 
the @code{master} branch and
 @example
 The first line should be the title of the commit
 
-An empty line is necessary after the title so Git does not confuse lines.
-This top paragraph of the body of the commit usually describes the reason this 
commit was done.
-Therefore it usually starts with "Until now ...".
-It is very useful to explain the reason behind the change, things that are not 
immediately obvious when looking into the code.
-You do not need to list the names of the files, or what lines have been 
changed, do not forget that the code changes are fully stored within Git :-).
-
-In the second paragraph (or any later paragraph!) of the body, we describe the 
solution and why (not "how"!) the particular solution was implemented.
-So we usually start this part of the commit body with "With this commit ...".
-Again, you do not need to go into the details that can be seen from the 'git 
diff' command (like the file names that have been changed or the code that has 
been implemented).
-The important thing here is the things that are not immediately obvious from 
looking into the code.
+An empty line is necessary after the title so Git does not confuse
+lines.  This top paragraph of the body of the commit usually describes
+the reason this commit was done.  Therefore it usually starts with
+"Until now ...".  It is very useful to explain the reason behind the
+change, things that are not immediately obvious when looking into the
+code.  You do not need to list the names of the files, or what lines
+have been changed, do not forget that the code changes are fully stored
+within Git :-).
+
+In the second paragraph (or any later paragraph!) of the body, we
+describe the solution and why (not "how"!) the particular solution was
+implemented.  So we usually start this part of the commit body with
+"With this commit ...".  Again, you do not need to go into the details
+that can be seen from the 'git diff' command (like the file names that
+have been changed or the code that has been implemented).  The important
+thing here is the things that are not immediately obvious from looking
+into the code.
 
 You can continue the explanation and it is encouraged to be very
-explicit about the "human factor" of the change as much as possible,
-not technical details.
+explicit about the "human factor" of the change as much as possible, not
+technical details.
 @end example