diff options
| author | Mattias Andrée <maandree@operamail.com> | 2015-08-07 19:44:31 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2015-08-07 19:44:31 +0200 |
| commit | 00277bcb9c5fab6a85de1877c2413be604be8aac (patch) | |
| tree | 4d92f892dbd479bd71b1f727800538b760da804c /doc/style-guide-for-documentation | |
| parent | typo (diff) | |
| download | mds-00277bcb9c5fab6a85de1877c2413be604be8aac.tar.gz mds-00277bcb9c5fab6a85de1877c2413be604be8aac.tar.bz2 mds-00277bcb9c5fab6a85de1877c2413be604be8aac.tar.xz | |
update style guide for doc
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc/style-guide-for-documentation')
| -rw-r--r-- | doc/style-guide-for-documentation | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/style-guide-for-documentation b/doc/style-guide-for-documentation index 2eaf185..ce289ee 100644 --- a/doc/style-guide-for-documentation +++ b/doc/style-guide-for-documentation @@ -281,3 +281,17 @@ For example: ‘a July-night’ (starts with semivowel ‘j’, or alternatively consonant ‘dj’) ‘a ‘one’’ (phonetically starts with semivowel ‘w’) + + + +Units +----- + +Abstain from putting spaces between units and their multiplier. For example 1 metre, +should be written ‘1m’. This can help reduce ambiguity. For example, +“The computers in my house have 2 Gb/s ethernet-ports.” does not mean the same thing as +“The computers in my house have 2Gb/s ethernet-ports.” In fact, the first former means +“The computers in my house have 2 ethernet-ports with Gb/s capacity.” and the latter +means “The computers in my house have ethernet-ports with 2Gb/s capacity.” +This is however only important, if ambiguity is possible. + |