Hey all, The docs are sometimes written with the passive voice when IMO they would be easier to read in the active voice.
An example from the Agent docs: https://github.com/elixir-lang/elixir/compare/master...hassanshaikley:agent-docs-imo?expand=1 Relevant piece on when to use the Active vs Passive voice in documentation by Daphne Watson: https://medium.com/@DaphneWatson/technical-writing-active-vs-passive-voice-485dfaa4e498 The definitions of the active and the passive voice from: https://www.reddit.com/r/explainlikeimfive/comments/rpr2q/eli5_active_voice_vs_passive_voice/c47n837?utm_source=share&utm_medium=web2x In the active voice, the subject of the sentence is the thing that's doing > the action (the student, in your case). In passive voice, the subject is > the recipient of the action (the book). As for the difference, well, read > them - don't they sound different? As you picture what's happening, doesn't > your mind visualize it differently? Examples from: https://writing.wisc.edu/handbook/style/ccs_activevoice/ Passive: It was earlier demonstrated that heart attacks can be caused by > high stress. > Active: Researchers earlier showed that high stress can cause heart > attacks. I would love to hear what y'all think! -- 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/ac6f9057-0864-4f4e-9a29-6e27d367ac9e%40googlegroups.com.
