pydocstyle icon indicating copy to clipboard operation
pydocstyle copied to clipboard

[Feature Request] Periods at the end of sections and args for Google style

Open rhshadrach opened this issue 3 years ago • 2 comments

I'm not aware if there is an official Google style specification, I've always used the napoleon docs examples as a guide. Based off of those, I've always thought each section should be written in full sentences, and likewise each argument description should be a full sentence.

Would checking for periods at the end of sections as well as arguments be a welcome feature?

rhshadrach avatar Jul 13 '21 21:07 rhshadrach

I'm not aware if there is an official Google style specification

The pydocstyle docs point to https://google.github.io/styleguide/pyguide.html as the official style specification, I'm guessing that's what they use.

adamjstewart avatar Jul 16 '21 16:07 adamjstewart

Thanks @adamjstewart - I do not see anything explicitly saying whether or not sections/args should end with a period, although all examples there have them. The only relevant text I could find is:

Pay attention to punctuation, spelling, and grammar; it is easier to read well-written comments than badly written ones.

Comments should be as readable as narrative text, with proper capitalization and punctuation. In many cases, complete sentences are more readable than sentence fragments. Shorter comments, such as comments at the end of a line of code, can sometimes be less formal, but you should be consistent with your style.

This says to me each section should be full sentences, but I will admit I do find it a bit ambiguous.

rhshadrach avatar Jul 16 '21 21:07 rhshadrach