From a4eb6414bf43b78d5b7bb7750e6c40b9a197e020 Mon Sep 17 00:00:00 2001 From: Timo Bakx Date: Mon, 28 Oct 2019 09:26:17 +0100 Subject: [PATCH] Remove assumption about why people read the documentation --- contributing/documentation/standards.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/contributing/documentation/standards.rst b/contributing/documentation/standards.rst index 49ebb3ef08b..7edd66ab061 100644 --- a/contributing/documentation/standards.rst +++ b/contributing/documentation/standards.rst @@ -175,11 +175,10 @@ In addition, documentation follows these rules: * his or hers, use theirs * himself or herself, use themselves -* **Avoid belittling words**: People read documentation because they know very - little about a specific topic or are even completely new to it. Things that - seem "obvious" or "simple" for the person documenting it, can be the exact - opposite for the reader. To make sure everybody feels comfortable when reading - the documentation, try to avoid words like: +* **Avoid belittling words**: Things that seem "obvious" or "simple" for the + person documenting it, can be the exact opposite for the reader. To make sure + everybody feels comfortable when reading the documentation, try to avoid words + like: * basically * clearly