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
{{ message }}
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
D4xx: First sentence of a docstring should be capitalized ("Return", not "return")
I haven't found a section in the original PEP that refers to capitalization, but all of the examples in the PEP are correctly capitalized. I'm wondering whether this new error should be checked by default. My instinct says that "a phrase ending in a period" (from the PEP) is a proper sentence, which should be capitalized, but I'm not sure if the PEP mandates it.
Does anyone have any thought regarding this?
The text was updated successfully, but these errors were encountered:
So PEP 8 authors are typically happy to clarify their intentions. You can implement this while you wait for a response from the PEP 257 authors and then put it in the default ignore list if you'd like.
This docstring
Should return an error in this style:
D4xx: First sentence of a docstring should be capitalized ("Return", not "return")
I haven't found a section in the original PEP that refers to capitalization, but all of the examples in the PEP are correctly capitalized. I'm wondering whether this new error should be checked by default. My instinct says that "a phrase ending in a period" (from the PEP) is a proper sentence, which should be capitalized, but I'm not sure if the PEP mandates it.
Does anyone have any thought regarding this?
The text was updated successfully, but these errors were encountered: