Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

    The user needs to know that some data has already been sent, 
    to stop [the user] from sending it twice.

    [...] is our only way to signal to the user that [the user] 
    should stop writing [...]
When considering pronouns at all, take recourse to The Zen of Python:

    Explicit is better than implicit.
It is not about non-gendered/gendered. Pronouns shouldn't be used at all. This improves documentation.

Using "they", regardless of the "gendered pronoun" debate is incorrect. The "user" might be transgendered, or might identify as Third Gender. Source Code and Documentation should contain no gender leanings what-so-ever, in preference for explicitness.



I think alternating and writing sporadic genderfication into our Documentation is a bad idea. It will only further promote undisciplined writing.

Using "it/they/them" decreases findability and grep-ability of the Documentation.

Generally pronouns increase the signal-to-noise ratio. "The User" or less noise increases the visibility and viability of search hooks.

We should find a way to (a) drop pronouns all together, which ultimately involves (b) rewriting the sentence, or (c) writing with explicitness.


Avoiding pronouns decreases readability of documentation. And readability is more fundamental to the purpose of documentation that "findability" and "grepability".

And, given the need for explicit referents preceding uses of pronouns (other than "one"/"many", which aren't the kind of pronouns at issue here), using them properly doesn't negatively impact searching.


Readability has a subjective basis and in this case comes with a cost. Findability and grepability have clear advantages without the cost that readability incurs (the gendered pronoun debate). If you apply a pure text search engine over such documentation, relevance and discovery is enhanced. Signal-to-noise, again.

You're telling me that "it" or "they" riddled more often than otherwise does not negatively affect search results? Pronouns increase the chance irrelevant results. This is implied by your use of "properly"; which only begs the question.


> You're telling me that "it" or "they" riddled more often than otherwise does not negatively affect search results?

Basically. More specifically, I would say that using definite pronouns improves search results.

> Pronouns increase the chance irrelevant results.

No, because there is no reason to search for definite pronouns, you search for the nouns that are the antecedents of definite pronouns (since using a definite pronoun requires using a noun as an antecedent in writing -- this can be substituted by gesture or other non-verbal cues in oral communication.) And if you use pronouns, you get less result clutter for those searches for the same reasons that you get better readability, you have less close-proximity repetition of the key nouns.


I just want to state that I think we have an interesting sub-discussion/set of theories here, even if mine is radically false. It's true or false on account of testability, in the end, I genuinely believe.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: