Home > Archive > PostgreSQL Documentation > May 2005 > punctuation in function tables









You are viewing an archived Text-only version of the thread. To view this thread in it's original format and/or if you want to reply to this thread please [click here]

 

Author punctuation in function tables
Neil Conway

2005-05-19, 8:24 pm

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

---------------------------(end of broadcast)---------------------------
TIP 8: explain analyze is your friend

Neil Conway

2005-05-22, 8:23 pm

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

---------------------------(end of broadcast)---------------------------
TIP 2: you can get off all lists at once with the unregister command
(send "unregister YourEmailAddressHere
" to majordomo@postgresql
.org)

Sponsored Links





Also available: Server administration forum archive | Web Design forum archive | Software forum archive | Hardware reviews archive | Programming forum archive

Copyright 2008 droptable.com