godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5880 from aaronfranke/active-direct

Browse Source 
Docs writing guidelines: Replace "direct" with "active"

(cherry picked from commit dfd020cb5f)
This commit is contained in:
Aaron Franke
2022-06-16 15:30:18 -04:00
committed by Max Hilbrunner
parent ea9ed7d272
commit 4903f016cd
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
community/contributing/docs_writing_guidelines.rst
View File

@@ -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.