Repository navigation
Javadoc warnings are the only noise on an otherwise clean CI run #4
Description
The build is green, but the run surfaces javadoc warnings as GitHub annotations — for example
Commutable.java#58: "no comment", "no @return". Harmless, but they are the only noise on the run,
which makes a real annotation easy to miss.
What to do: either write the missing javadoc on the handful of public members that warn, or
decide the project does not want javadoc enforcement on internal modules and configure the task
accordingly. Please do not silence it globally without saying why in the build file.
Recorded in docs/landing-surface-checklist.md §3.
Activity
jayeshamundkar06-bit commentedon Nov 2, 2026
Hi! I'd like to work on this issue as my first open-source contribution.
I can investigate the Javadoc warnings, identify the affected public members, and add the missing documentation while ensuring the build remains clean.
Is this issue still available for contribution? I'd be happy to work on it.
Thank you!
bnaudts commentedon Nov 3, 2026
Thanks for your interest. Yes, the issue is open; go ahead and feel free to contact me for questions. Please read CONTRIBUTING.md. It is probably a bit strict on testing; for this issue, slowTests are not necessary.