diff options
author | Arnout Engelen <arnout@bzzt.net> | 2023-11-09 21:48:05 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-11-09 21:48:05 +0100 |
commit | 97b0ae26f7c8a1682b5437a64edcd73ab1798c9b (patch) | |
tree | b7a421f5dd7358d9c2099c4717aa49525addc700 /nixos/doc/manual/development | |
parent | 3dc0248dbc70fdba6d1a668ed00b4678dfae098c (diff) | |
download | nixpkgs-97b0ae26f7c8a1682b5437a64edcd73ab1798c9b.tar nixpkgs-97b0ae26f7c8a1682b5437a64edcd73ab1798c9b.tar.gz nixpkgs-97b0ae26f7c8a1682b5437a64edcd73ab1798c9b.tar.bz2 nixpkgs-97b0ae26f7c8a1682b5437a64edcd73ab1798c9b.tar.lz nixpkgs-97b0ae26f7c8a1682b5437a64edcd73ab1798c9b.tar.xz nixpkgs-97b0ae26f7c8a1682b5437a64edcd73ab1798c9b.tar.zst nixpkgs-97b0ae26f7c8a1682b5437a64edcd73ab1798c9b.zip |
doc: avoid 'simply' (#266434)
While the word 'simply' is usually added to encourage readers, it often has the opposite effect and may even appear condescending, especially when the reader runs into trouble trying to apply the suggestions from the documentation. It is almost always an improvement to simply drop the word from the sentence. (there are more possible improvements like this, we can apply those in separate PRs)
Diffstat (limited to 'nixos/doc/manual/development')
-rw-r--r-- | nixos/doc/manual/development/writing-documentation.chapter.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/nixos/doc/manual/development/writing-documentation.chapter.md b/nixos/doc/manual/development/writing-documentation.chapter.md index 8cb6823d098..c07a2618c07 100644 --- a/nixos/doc/manual/development/writing-documentation.chapter.md +++ b/nixos/doc/manual/development/writing-documentation.chapter.md @@ -50,7 +50,7 @@ pandoc -f markdown_github -t docbook5 docs.md -o my-section.md Pandoc can also quickly convert a single `section.xml` to HTML, which is helpful when drafting. -Sometimes writing valid DocBook is simply too difficult. In this case, +Sometimes writing valid DocBook is too difficult. In this case, submit your documentation updates in a [GitHub Issue](https://github.com/NixOS/nixpkgs/issues/new) and someone will handle the conversion to XML for you. |