Fix Javadoc issues per Oracle conventions#1599
Conversation
|
-1: Sentences end in a period. This matters even more when there is more than one sentence in a description. The first sentence ends in a period but the second wouldn't? That makes no sense and looks like a typos to boot. |
Sentences end in a period. Sentence fragments do not end in a period. This change does not make second sentence not end in a period (or if it does that's a bug) |
|
It's just simpler to end in a period, whether there is one sentence or two. The subtle differences Oracle tries to make are, IMO, absurd, for example, these examples where 3 out of 4 descripions end in a period:
You can just end with a period and keep it simple. There’s no advantage to making this distinction, especially for non-native English speakers. There is no "Sentence fragments". |
|
sentence fragments == phrases. These are subtle and picky, which is why iut;'s helpful to use an automated tool to take care of it instead of trying to remember the rules and nit picking on every PR |
No description provided.