diff mbox

[docs] invoke.texi: random copy-editing

Message ID alpine.LSU.2.20.1609012103090.3437@anthias.pfeifer.com
State New
Headers show

Commit Message

Gerald Pfeifer Sept. 1, 2016, 7:04 p.m. UTC 
On Wed, 29 Aug 2012, Sandra Loosemore wrote:
> 	* doc/invoke.texi: Fix numerous typos and punctuation/grammatical
> 	errors throughout the file.  Re-word some awkward sentences and
> 	paragraphs.

I noticed you changed return-value and return-type to their 
variants without a dash.  Would it make sense to add the 
following to https://gcc.gnu.org/codingconventions.html#Spelling ?

Gerald

Comments

Sandra Loosemore Sept. 5, 2016, 5 p.m. UTC | #1 
On 09/01/2016 01:04 PM, Gerald Pfeifer wrote:
> On Wed, 29 Aug 2012, Sandra Loosemore wrote:
>> 	* doc/invoke.texi: Fix numerous typos and punctuation/grammatical
>> 	errors throughout the file.  Re-word some awkward sentences and
>> 	paragraphs.
>
> I noticed you changed return-value and return-type to their
> variants without a dash.  Would it make sense to add the
> following to https://gcc.gnu.org/codingconventions.html#Spelling ?
>
> Gerald
>
> Index: codingconventions.html
> ===================================================================
> RCS file: /cvs/gcc/wwwdocs/htdocs/codingconventions.html,v
> retrieving revision 1.76
> diff -u -r1.76 codingconventions.html
> --- codingconventions.html	16 Aug 2016 09:24:33 -0000	1.76
> +++ codingconventions.html	1 Sep 2016 19:02:58 -0000
> @@ -457,6 +457,11 @@
>       <td></td>
>     </tr>
>     <tr>
> +    <td>"return type", "return value"</td>
> +    <td>"return-type", "return-value"</td>
> +    <td></td>
> +  </tr>
> +  <tr>
>       <td>"run time" (noun), "run-time" (adjective);
>         the time at which the program is run</td>
>       <td>"runtime"</td>

Perhaps add here that "return type" and "return value" are nouns.  It 
would be correct to hyphenate them if they were used as adjective 
phrases immediately before a noun (although I'm having trouble coming up 
with an example of such usage that would make any sense).

-Sandra
diff mbox

Patch

Index: codingconventions.html
===================================================================
RCS file: /cvs/gcc/wwwdocs/htdocs/codingconventions.html,v
retrieving revision 1.76
diff -u -r1.76 codingconventions.html
--- codingconventions.html	16 Aug 2016 09:24:33 -0000	1.76
+++ codingconventions.html	1 Sep 2016 19:02:58 -0000
@@ -457,6 +457,11 @@ 
     <td></td>
   </tr>
   <tr>
+    <td>"return type", "return value"</td>
+    <td>"return-type", "return-value"</td>
+    <td></td>
+  </tr>
+  <tr>
     <td>"run time" (noun), "run-time" (adjective);
       the time at which the program is run</td>
     <td>"runtime"</td>