Skip to content

Fix Javadoc issues per Oracle conventions - #84

Open
elharo wants to merge 1 commit into
apache:mainfrom
elharo:jd4
Open

Fix Javadoc issues per Oracle conventions#84
elharo wants to merge 1 commit into
apache:mainfrom
elharo:jd4

Conversation

@elharo

@elharo elharo commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Thanks for your contribution to Apache Commons! Your help is appreciated!

Before you push a pull request, review this list:

  • [X ] Read the contribution guidelines for this project.
  • [ X] Read the ASF Generative Tooling Guidance if you use Artificial Intelligence (AI).
  • I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute?
  • [ X] Run a successful build using the default Maven goal with mvn; that's mvn on the command line by itself.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice.
  • [ X] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • [X ] Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process.

@garydgregory

garydgregory commented Sep 2, 2026

Copy link
Copy Markdown
Member

-1 this is not the convention we use all over Commons. I'd rather be consistent in the Commons direction Sentences start with a capital letter, like I'm writing here. i don't write like this. Starting a sentence with "if ..." and no "then" or resolution, is equally bad, so hence exception docs start with "Thrown ...".

I just did a pass for grammar and such and it would be better to review the meaning of the text.

@elharo

elharo commented Sep 2, 2026

Copy link
Copy Markdown
Contributor Author

Then commons is deviating from the explicit Oracle conventions used across the entire Java ecosystem. See https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html

@garydgregory

Copy link
Copy Markdown
Member

Yes, it's a convention, not a set of handcuffs.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants