monotone-commits-diffs
[Top][All Lists]
Advanced

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

[Monotone-commits-diffs] net.venge.monotone.string-sanitization: 83d216


From: code
Subject: [Monotone-commits-diffs] net.venge.monotone.string-sanitization: 83d2161320c3696daa94724132fb1f2d210070b3
Date: Tue, 8 Mar 2011 10:34:19 +0100 (CET)

revision:            83d2161320c3696daa94724132fb1f2d210070b3
date:                2011-03-08T09:26:04
author:              Richard Levitte <address@hidden>
branch:              net.venge.monotone.string-sanitization
changelog:
* HACKING: Clarify punctuation and correct a few mistakes.

manifest:
format_version "1"

new_manifest [6990e2d0f3db2b2677a8d9fc76d7764678cbae6a]

old_revision [0a78ed1be81489b1cfe5245ae21855d47f1ed6ce]

patch "HACKING"
 from [5bd247a6d06d0b45781f765137c45b0f58f8ae5d]
   to [b2d761b281252e2b83e5afaec194c5fce2baaa24]
============================================================
--- HACKING	5bd247a6d06d0b45781f765137c45b0f58f8ae5d
+++ HACKING	b2d761b281252e2b83e5afaec194c5fce2baaa24
@@ -54,19 +54,21 @@ Formatting messages
 Formatting messages
 -------------------
 
-For short error messages, we follow the GNU coding standards.
-However, those are not quite enough, and we have developed an
-extended set of rules to follow for messages in english:
+For short messages (single sentence error, warning, info and progress
+messages), we follow the GNU coding standards.  However, those are not
+quite enough, and we have developed an extended set of rules to follow
+for messages in english:
 
   - put single quotes ('') aroung file names and paths, option names,
     tag names and branch names, as well as any %s that would be
     expanded to one of those.
 
   - use a Capital first letter in command abstract and description
-    strings.  The following would be very wrong:
+    strings.  Do not put a period at the end of the abstract, but do
+    so with the description.  The following would be very wrong:
 
         CMD(foo, "foo", "", CMD_REF(foos), "",
-            N_("does the foo thing"),
+            N_("does the foo thing."),
             N_("in order to do the foo thing, this allows you to join "
                "the foo fighters"),
 
@@ -75,20 +77,21 @@ extended set of rules to follow for mess
         CMD(foo, "foo", "", CMD_REF(foos), "",
             N_("Does the foo thing"),
             N_("In order to do the foo thing, this allows you to join "
-               "the foo fighters"),
+               "the foo fighters."),
 
-  - use a lowercase first letter in descriptions of options.  The
+  - just as with error messages, use a lowercase first letter in
+    descriptions of options and do not end it with a period.  The
     following would be wrong:
 
         SIMPLE_OPTION(bar, "bar", bool,
                       gettext_noop("Have the remaining figures go to "
-                                   the nearest bar"))
+                                   "the nearest bar."))
 
     The following is better:
 
         SIMPLE_OPTION(bar, "bar", bool,
                       gettext_noop("have the remaining figures go to "
-                                   the nearest bar"))
+                                   "the nearest bar"))
 
   - for multi-sentence error messages, use a lowercase first letter,
     but have the second sentence and on start with a Capital letter,

reply via email to

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