While this is an interesting thought, I'm not convinced it makes sense to 
adopt as a practice. Citing the same reference you provide:

When deciding between using Active or Passive Voice, ask the question: “Is 
> it an advantage for the reader to know the performer of the action?”
> If the answer is Yes, use Active Voice. If the answer is No, use Passive 
> Voice.


Consider the contexts in which a function's documentation may be consulted:

   - Clicking a link in a forum to the doc site
   - Intellisense pop-up on hover
   - Searching the doc site for a function
   - Within a REPL
   - Copy-pasted into a thread


In these contexts, the actual "performer" of the action--in the sense of 
both whom the caller is, and who is running the program that invokes the 
caller, can be very varied. Passive voice is useful in its anonymity about 
the caller, and trying to be more specific seems to me like it would only 
confuse most snippets.

-- 
You received this message because you are subscribed to the Google Groups 
"elixir-lang-core" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/elixir-lang-core/edec2a8b-24b6-4750-9928-688315856e54%40googlegroups.com.

Reply via email to