| Lists: | pgsql-docs |
|---|
| From: | Neil Conway <neilc(at)samurai(dot)com> |
|---|---|
| To: | pgsql-docs(at)postgresql(dot)org |
| Subject: | punctuation in function tables |
| Date: | 2005-05-20 01:35:12 |
| Message-ID: | 428D3ED0.3090002@samurai.com |
| Views: | Raw Message | Whole Thread | Download mbox | Resend email |
| Lists: | pgsql-docs |
The function definition tables in func.sgml use punctuation
inconsistently: some descriptions are terminated by a period, some are
not. Is there any opinion on which variant is "correct"?
If not, I'll update the docs so that sentences in descriptions are
separated by periods, rather than terminated: so single sentence
descriptions will have no period, and multiple sentence descriptions
will have periods except for the last sentence. I have a vague
recollection that we use this style elsewhere...
-Neil
| From: | Neil Conway <neilc(at)samurai(dot)com> |
|---|---|
| To: | Neil Conway <neilc(at)samurai(dot)com> |
| Cc: | pgsql-docs(at)postgresql(dot)org |
| Subject: | Re: punctuation in function tables |
| Date: | 2005-05-23 01:31:20 |
| Message-ID: | 42913268.7030305@samurai.com |
| Views: | Raw Message | Whole Thread | Download mbox | Resend email |
| Lists: | pgsql-docs |
Neil Conway wrote:
> The function definition tables in func.sgml use punctuation
> inconsistently: some descriptions are terminated by a period, some are
> not. Is there any opinion on which variant is "correct"?
I ended up not including a period in single-sentence function
descriptions, but using both separating and terminating periods in
multiple-sentence descriptions. Applied to HEAD.
-Neil