From f92c41457ad30c7a2b0b7187338b2f3ba09f152c Mon Sep 17 00:00:00 2001 From: Stan Ulbrych Date: Wed, 6 Aug 2025 22:23:03 +0200 Subject: [PATCH 1/3] Commit --- documentation/style-guide.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/documentation/style-guide.rst b/documentation/style-guide.rst index 49bd15b1d..cad0ceb0f 100644 --- a/documentation/style-guide.rst +++ b/documentation/style-guide.rst @@ -103,11 +103,16 @@ Unix Use simple language =================== -Avoid esoteric phrasing where possible. Our audience is world-wide and may not -be native English speakers. - -Don't use Latin abbreviations like "e.g." or "i.e." where English words will do, -such as "for example" or "that is." +The documentation has a world-wide audience of varying English proficiency. +To make the documentation more accessible and inclusive, the following should be +avoided: + +- Esoteric phrasing. +- Abbreviations, such as Latin "e.g." or "i.e.," or symbols, such as the + ampersand ('&'), where English words will do, such as + "for example", "that is" and "and," respectively. +- Idioms, as they are often confusing to non-native speakers and + are difficult to translate. .. index:: diataxis From b1a65ba58fa897e4304cf2e025ade3abfd069613 Mon Sep 17 00:00:00 2001 From: Stan Ulbrych Date: Sun, 17 Aug 2025 14:59:37 +0200 Subject: [PATCH 2/3] Commit --- documentation/translations/translating.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documentation/translations/translating.rst b/documentation/translations/translating.rst index 7d1e2f251..e7ae1b66a 100644 --- a/documentation/translations/translating.rst +++ b/documentation/translations/translating.rst @@ -41,9 +41,8 @@ For more details about translations and their progress, see `the dashboard - Sanyam Khurana (:github-user:`CuriousLearner`) - :github:`GitHub ` * - Hungarian (hu) - - Tamás Bajusz (:github-user:`gbtami`) + - - :github:`GitHub `, - `mailing list `__ * - `Indonesian (id) `__ - | Irvan Putra (:github-user:`irvan-putra`), | Jeff Jacobson (:github-user:`jwjacobson`) From 45b2571051a0dab2e4f5b42d3a91730c03230e44 Mon Sep 17 00:00:00 2001 From: Stan Ulbrych Date: Sun, 17 Aug 2025 15:02:32 +0200 Subject: [PATCH 3/3] Revert "Commit" This reverts commit b1a65ba58fa897e4304cf2e025ade3abfd069613. --- documentation/translations/translating.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/translations/translating.rst b/documentation/translations/translating.rst index e7ae1b66a..7d1e2f251 100644 --- a/documentation/translations/translating.rst +++ b/documentation/translations/translating.rst @@ -41,8 +41,9 @@ For more details about translations and their progress, see `the dashboard - Sanyam Khurana (:github-user:`CuriousLearner`) - :github:`GitHub ` * - Hungarian (hu) - - + - Tamás Bajusz (:github-user:`gbtami`) - :github:`GitHub `, + `mailing list `__ * - `Indonesian (id) `__ - | Irvan Putra (:github-user:`irvan-putra`), | Jeff Jacobson (:github-user:`jwjacobson`)