database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-10-27 00:12:01 +03:00
Code Activity

Properly capitalize documentation headings; some only had initial-word

Browse Source 
capitalization.
This commit is contained in:
Bruce Momjian
2011-01-29 13:00:18 -05:00
parent 6f489dca65
commit 5d5678d7c3
65 changed files with 447 additions and 447 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/src/sgml/sources.sgml
View File

@@ -326,7 +326,7 @@ ereport(level, (errmsg_internal("format string", ...)));
</para>
<simplesect>
<title>What goes where</title>
<title>What Goes Where</title>
<para>
The primary message should be short, factual, and avoid reference to
@@ -388,7 +388,7 @@ Hint: the addendum
</simplesect>
<simplesect>
<title>Quotation marks</title>
<title>Quotation Marks</title>
<para>
English text should use double quotes when quoting is appropriate.
@@ -409,7 +409,7 @@ Hint: the addendum
</simplesect>
<simplesect>
<title>Use of quotes</title>
<title>Use of Quotes</title>
<para>
Use quotes always to delimit file names, user-supplied identifiers, and
@@ -433,7 +433,7 @@ Hint: the addendum
</simplesect>
<simplesect>
<title>Grammar and punctuation</title>
<title>Grammar and Punctuation</title>
<para>
The rules are different for primary error messages and for detail/hint
@@ -472,7 +472,7 @@ Hint: the addendum
</simplesect>
<simplesect>
<title>Upper case vs. lower case</title>
<title>Upper Case vs. Lower Case</title>
<para>
Use lower case for message wording, including the first letter of a
@@ -488,7 +488,7 @@ Hint: the addendum
</simplesect>
<simplesect>
<title>Avoid passive voice</title>
<title>Avoid Passive Voice</title>
<para>
Use the active voice. Use complete sentences when there is an acting
@@ -504,7 +504,7 @@ Hint: the addendum
</simplesect>
<simplesect>
<title>Present vs past tense</title>
<title>Present vs. Past Tense</title>
<para>
Use past tense if an attempt to do something failed, but could perhaps
@@ -544,7 +544,7 @@ cannot open file "%s"
</simplesect>
<simplesect>
<title>Type of the object</title>
<title>Type of the Object</title>
<para>
When citing the name of an object, state what kind of object it is.
@@ -573,7 +573,7 @@ cannot open file "%s"
</simplesect>
<simplesect>
<title>Assembling error messages</title>
<title>Assembling Error Messages</title>
<para>
When a message includes text that is generated elsewhere, embed it in
@@ -594,7 +594,7 @@ could not open file %s: %m
</simplesect>
<simplesect>
<title>Reasons for errors</title>
<title>Reasons for Errors</title>
<para>
Messages should always state the reason why an error occurred.
@@ -609,7 +609,7 @@ BETTER: could not open file %s (I/O failure)
</simplesect>
<simplesect>
<title>Function names</title>
<title>Function Names</title>
<para>
Don't include the name of the reporting routine in the error text. We have
@@ -641,7 +641,7 @@ BETTER: could not open file %s: %m
</simplesect>
<simplesect>
<title>Tricky words to avoid</title>
<title>Tricky Words to Avoid</title>
<formalpara>
<title>Unable</title>
@@ -717,7 +717,7 @@ BETTER: unrecognized node type: 42
</simplesect>
<simplesect>
<title>Proper spelling</title>
<title>Proper Spelling</title>
<para>
Spell out words in full. For instance, avoid: