From 885c4285feb560b80c61ee19eb4ad079d5b29e4f Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Wed, 25 Oct 2023 11:29:17 +0200 Subject: [PATCH] introduce examples more clearly --- source/contributing/documentation/style-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/contributing/documentation/style-guide.md b/source/contributing/documentation/style-guide.md index e39607040..e06b7f311 100644 --- a/source/contributing/documentation/style-guide.md +++ b/source/contributing/documentation/style-guide.md @@ -23,12 +23,12 @@ Use this leverage with care. - Don't use long, complicated words if there are shorter, simpler words that convey the same meaning. - Use the imperative voice when giving instructions. - Example: + For example, write: > Add the `python310` package to `buildInputs`. Don't use a conversational tone, as it distracts from the contents. - Counter-example: + For example, don't write: > Going forward, let's now add the `python310` package to `buildInputs` as we have seen in the previous tutorial.