Docs: Fix ambiguous pronoun #100376
Docs: Fix ambiguous pronoun #100376
Conversation
"It" could be taken to refer to the 'name with a leading underscore' convention itself, rather than to the variable whose name follows that convention.
|
The following commit authors need to sign the Contributor License Agreement: Click the button to sign: |
Is a CLA required for this PR? I don't trust the bot's assessment. |
|
re: CLA, not a lawyer, I think theoretically this change is minor enough that it wouldn't need the CLA, but I don't want to be in the business of adjudicating that and it's currently a required check in CI. So the main path forward is to sign it — at the least doing so will make your next contribution to CPython easier ;-) As for the change, I think I'd phrase it more concisely as:
|
|
I like @hauntsaninja's suggestion, with minor nit that "Such names..." is maybe better than "Such objects"? |
|
Hm, I think "such names" is potentially vulnerable to the same confusion OP has. I'd be fine with any of "such objects", "such APIs", "such variables" |
|
I don't think "such names" can be taken to refer to the convention itself, it has to refer to the names described by the convention? The reason I prefer "names" is that that is the most precise description of what this convention applies to. The object itself may or may not be private, if it is accessible by other (public) names. The name may or may not be an attribute (it could be a module global, which can be accessed as an attribute, but isn't usually described as one.) I guess it will always be an "API" if we take "API" broadly, but that seems to invite confusion. |
|
Feel free to re-open if you sign the CLA / consider one of the alternate phrasings above :-) |
"It" could be taken to refer to the 'name with a leading underscore' convention itself, rather than to the variable whose name follows that convention.
No issue as it's a trivial change.