Skip to content

Address review comment to use consistent punctuation in param javadoc#1427

Open
njr-11 wants to merge 1 commit intojakartaee:mainfrom
njr-11:1418-review-comment-for-periods-in-param-javaodc
Open

Address review comment to use consistent punctuation in param javadoc#1427
njr-11 wants to merge 1 commit intojakartaee:mainfrom
njr-11:1418-review-comment-for-periods-in-param-javaodc

Conversation

@njr-11
Copy link
Copy Markdown
Member

@njr-11 njr-11 commented Apr 15, 2026

Fixes this review comment from #1418 about inconsistent punctuation of @param javadoc in the Sort class,

#1418 (review)

The majority of @param javadoc in this class ends with ., so I updated the places where it was lacking.

@njr-11 njr-11 added this to the 1.1 milestone Apr 15, 2026
@njr-11 njr-11 added the documentation Improvements or additions to documentation label Apr 15, 2026
@pzygielo
Copy link
Copy Markdown
Contributor

The majority of @param javadoc in this class ends with ., so I updated the places where it was lacking.

But https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html says:

End the phrase with a period only if another phrase or sentence follows it.

@njr-11
Copy link
Copy Markdown
Member Author

njr-11 commented Apr 15, 2026

The majority of @param javadoc in this class ends with ., so I updated the places where it was lacking.

But https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html says:

End the phrase with a period only if another phrase or sentence follows it.

That's unfortunate. It means nearly all of the Javadoc I've contributed to specifications is out of compliance with Oracle's style guide. It will be a disruptive change to correct all of it - probably best to wait until a point when there are not other PRs pending to change that sort of thing due to the large number of lines it will impact and the merge conflicts that would cause.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants