aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/style-guide-for-documentation33
1 files changed, 16 insertions, 17 deletions
diff --git a/doc/style-guide-for-documentation b/doc/style-guide-for-documentation
index d3e5986..65f1aa6 100644
--- a/doc/style-guide-for-documentation
+++ b/doc/style-guide-for-documentation
@@ -190,8 +190,10 @@ verbatim sections and when referring a section or numbering a section.
Acronyms as generic words
-------------------------
-Unacceptable, always use captialised form.
-For example ‘LASER’ rather than ‘laser’.
+Unacceptable, always use captialised form. For example ‘LASER’ rather
+than ‘laser’. This is especially important for acronyms that are not
+pronounceable exactly. For example ‘radar’ is tolerable, but ‘tv’ is
+intolerable.
@@ -199,10 +201,9 @@ For example ‘LASER’ rather than ‘laser’.
-ize versus -ise
----------------
-Always -ise, no exceptions. All words that can be
-spelled with -ize can also be spelled with -ise,
-the reverse however is not true.
-For example ‘randomise’ rather than ‘randomize’.
+Always ‘-ise’, no exceptions. All words that can be spelled with
+‘-ize’ can also be spelled with ‘-ise’, the reverse however is not
+true. For example ‘randomise’ rather than ‘randomize’.
@@ -218,9 +219,8 @@ Only use serial comma when necessary.
Possessive form of classical and biblical names
-----------------------------------------------
-Adhere to the standard for non-classical, non-biblical
-names. For example ‘Socrates's philosophy’ rather than
-‘Socrates' philosophy’.
+Adhere to the standard for non-classical, non-biblical names. For
+example ‘Socrates's philosophy’ rather than ‘Socrates' philosophy’.
@@ -228,14 +228,13 @@ names. For example ‘Socrates's philosophy’ rather than
Plural of proper nouns
----------------------
-Proper nouns cannot be declenated to plural form with
-indefinite state or construct state. For example ‘there
-are two Richard in this room’ rather than ‘there are two
-Richards in this room’, and ‘both Richard.’ rather than
-‘both Richards’. However proper nouns can be declenated
-to plural form with definite state, but only when referring
-to a family, or multiple family, however dual-plural form
-is not allowed in this case.
+Proper nouns cannot be declenated to plural form with indefinite
+state or construct state. For example ‘there are two Richard in
+this room’ rather than ‘there are two Richards in this room’, and
+‘both Richard.’ rather than ‘both Richards’. However proper nouns
+can be declenated to plural form with definite state, but only
+when referring to a family, or multiple family, however dual-plural
+form is not allowed in this case.