Changes between Version 14 and Version 15 of MessageStandardization

Timestamp:

Aug 2, 2009, 5:19:52 AM (15 years ago)

Author:

martinl

Comment:

--

MessageStandardization

@@ -59 +59 @@
  * Either all '''module''' descriptions should end with periods or not. As some are multi-sentence, and thus should end in a period for consistency within the message, so probably they all should end in one. Currently by my count 237 end with '.', 139 do not. In the multi-sentence case it may be posible to put the simple description in the module->label field and additional explanitory text into the ->description field.
  * '''option''' and '''flag''' descriptions generally should not end in a period (more likely to be phrases than sentences). But they can suffer the same multi-sentence period problem as module descriptions. In this case splitting out additional text into a ->label, ->description split may help.
- * Suspension points used to indicate some process is being done should be placed next to last word, without space. e.g. "Reading map..." instead of "Reading map ..."[[BR]]
- --HB: FWIW & my 2c, 1) to me keeping the space before the ellipse looks better, is this a purely cosmetic choice or is there some style logic? [wikipedia article on the ellipse was cited on grass-dev, I would argue that refers to printed typeset text not monospace terminal text, strangely suggests punctuation+3 dots (....), is just one other guy's opinion, and I'm still not swayed]  2) these messages may be good candidates for G_verbose_message().[[BR]]
- -- HB 2c more: (i.landsat.rgb example)
+ * Suspension points used to indicate some process is being done should be placed next to last word, without space. e.g. 
+{{{
+Reading raster map...
+}}}
+ instead of
+{{{
+Reading raster map ...
+}}}
+ HB: FWIW & my 2c, 1) to me keeping the space before the ellipse looks better, is this a purely cosmetic choice or is there some style logic? [wikipedia article on the ellipse was cited on grass-dev, I would argue that refers to printed typeset text not monospace terminal text, strangely suggests punctuation+3 dots (....), is just one other guy's opinion, and I'm still not swayed]  2) these messages may be good candidates for G_verbose_message().[[BR]]
+ HB 2c more: (i.landsat.rgb example)
 {{{
   Processing <$i>...