garydgregory commented on PR #491: URL: https://github.com/apache/commons-io/pull/491#issuecomment-1750689816
> Except they aren't sentences. They're sentence fragments, and this case is explicitly called out in the [Oracle style guidelines](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#tag): "When writing the comments themselves, in general, start with a phrase and follow it with sentences if they are needed. When writing a phrase, do not capitalize and do not end with a period". > > If the project wants to diverge from that, it's worth calling it out explicitly in a project specific style guide. We do, under a header called "Respect The Original Style" on https://commons.apache.org/patches.html I suppose it could go into more detail of course ;-) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
