From 00277bcb9c5fab6a85de1877c2413be604be8aac Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Fri, 7 Aug 2015 19:44:31 +0200 Subject: update style guide for doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/style-guide-for-documentation | 14 ++++++++++++++ 1 file changed, 14 insertions(+) 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. + -- cgit v1.2.3-70-g09d2