groff-commit
[Top][All Lists]
Advanced

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

[groff] 10/72: BUG-REPORT: Fix style nits.


From: G. Branden Robinson
Subject: [groff] 10/72: BUG-REPORT: Fix style nits.
Date: Sun, 23 Oct 2022 22:25:34 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 0a4faa8ec67fa236f2e9a6642e7bd59b81e32774
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Oct 18 14:13:59 2022 -0500

    BUG-REPORT: Fix style nits.
    
    * Put the opening instructions themselves in brackets.
    * Explain which kind of brackets we mean, to fend off Brits who are both
      pedantic and averse to the term "parentheses".  (Oh, you'll take the
      Elgin Marbles but not this word? :P )
    * Use quotation marks more consistently: single quotes for names of
      files in the groff distribution and option literals, and double quotes
      for commands to be typed or elements of web forms.  (Not that anyone
      will notice the distinction.)
---
 BUG-REPORT | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/BUG-REPORT b/BUG-REPORT
index 8a7e22d68..efa994c36 100644
--- a/BUG-REPORT
+++ b/BUG-REPORT
@@ -6,25 +6,25 @@
 
                           groff Bug Report
 
-Please read the PROBLEMS file before submitting a bug report.
+[Please read the 'PROBLEMS' file before submitting a bug report.
 
 Please fill in all fields, even if you think they are not relevant.
 
-Please delete the text in brackets before submitting it.
+Please delete the text in square brackets before submitting it.
 
 Please report distinguishable problems separately.
 
-Place the completed form in a new bug report at
+Place this completed form in a new bug report at
 <http://savannah.gnu.org/bugs/?group=groff>.  Click on the "Bugs" link,
-then select "Submit new" from the menu.
+then select "Submit new" from the menu.]
 
 GROFF VERSION:
 [Put the output of the failing command when run with the '--version'
-option here.  For example, "groff --version".]
+option here.  For example, "groff --version" or "indxbib --version".]
 
 PLATFORM:
-[Put the output of the 'uname -a' command here.  On non-POSIX systems,
-some alternative should be available; on Windows systems, use 'ver'.]
+[Put the output of the "uname -a" command here.  On non-POSIX systems,
+some alternative should be available; on Windows systems, use "ver".]
 
 CONFIGURATION REPORT:
 [If you compiled groff yourself, include the portion of the 'configure'
@@ -48,12 +48,12 @@ a concrete example.]
 
 COMMAND LINE:
 [The command line that we should run in order to observe the bug.  For
-example, 'groff -Tps bug.tr'.]
+example, "groff -Tps bug.tr".]
 
 DESCRIPTION OF INCORRECT BEHAVIOUR:
-[What goes wrong when that command line is run?  For example, 'groff
-gets a segmentation fault.', or 'The output looks bad because the bar
-over the x is too long and is too far over to the left.'  If you get an
+[What goes wrong when that command line is run?  For example, "groff
+gets a segmentation fault.", or "The output looks bad because the bar
+over the x is too long and is too far over to the left."  If you get an
 error message, include it here without modification: don't edit it to
 make it more readable.]
 



reply via email to

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