Skip to content

Commit

Permalink
introduce examples more clearly
Browse files Browse the repository at this point in the history
  • Loading branch information
fricklerhandwerk authored Oct 25, 2023
1 parent 0342dcb commit 885c428
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions source/contributing/documentation/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 885c428

Please sign in to comment.