From 4903f016cd8c79770740daeaab4dda90391228d4 Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Thu, 16 Jun 2022 15:30:18 -0400 Subject: [PATCH] Merge pull request #5880 from aaronfranke/active-direct Docs writing guidelines: Replace "direct" with "active" (cherry picked from commit dfd020cb5fd1ef19ac7d1d7457f435520d6a091b) --- community/contributing/docs_writing_guidelines.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/community/contributing/docs_writing_guidelines.rst b/community/contributing/docs_writing_guidelines.rst index b67ad594b..98626bc9c 100644 --- a/community/contributing/docs_writing_guidelines.rst +++ b/community/contributing/docs_writing_guidelines.rst @@ -11,7 +11,7 @@ for everyone and precise. In summary, always try to: -1. Use the direct voice +1. Use the active voice 2. Use precise action verbs 3. Avoid verbs that end in -ing 4. Remove unnecessary adverbs and adjectives. @@ -40,10 +40,10 @@ There are 3 rules to describe classes: 7 rules for clear English ------------------------- -Use the direct voice +Use the active voice ~~~~~~~~~~~~~~~~~~~~ -Use the direct voice when possible. Take the classes, methods, and +Use the active voice when possible. Take the classes, methods, and constants you describe as the subject. It's natural to write using the passive voice, but it's harder to read and produces longer sentences.