You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There's nothing wrong with the passive voice used correctly. Uh,
"there's nothing wrong with my using the passive voice?" "There's
nothing wrong with our using the passive voice?" Uh, no. ;-)
Technical documentation frequently needs the passive voice because the
agent is the "we" sometimes used in textbooks or tutorials consisting
of the reader and the writer which is better unstated.
I've changed the guideline to specify that what is discouraged is the
passive voice when the active voice is equally good--namely, in cases
where you'd need to use the word "by" in the passive.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,8 @@ in the [#perl6 IRC channel](https://perl6.org/community/irc).
40
40
41
41
## General principles
42
42
43
-
* Please use the present tense, and [active voice](https://en.wikipedia.org/wiki/Active_voice).
43
+
* Please use the present tense unless writing about history or upcoming events or planned features
44
+
* Prefer [active voice](https://en.wikipedia.org/wiki/Active_voice) to the [passive voice](https://en.wikipedia.org/Passive_voice#In_English) with "by": "this is used by crafty programmers" → "crafty programmers use this"
44
45
* Link to external resources (like Wikipedia) for topics that are not
45
46
directly related to Perl 6 (like the math that our routines implement).
46
47
* Duplicate small pieces of information rather than rely on linking.
0 commit comments