Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixed paragraphs in javadoc comments #3397

Merged
merged 1 commit into from
Oct 7, 2024
Merged

Conversation

Zopsss
Copy link
Contributor

@Zopsss Zopsss commented Oct 7, 2024

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Hello there, I'm a contributor at @checkstyle, I was working on this issue: checkstyle/checkstyle#15685, my PR: checkstyle/checkstyle#15686

The issue is about fixing JavadocParagraph's Implementation, currently the check does not work when a paragraph tag have it's corresponding closing tag ( <p></p>), it only works when paragraph tag does not have its corresponding closing tag ( <p> ). I was trying to fix this problem and during this process I also found some other bugs which I have solved in the same PR.

The PR is almost ready to be merged but our semaphore CI was failing, here its error logs: https://checkstyle.semaphoreci.com/jobs/fa77db90-12db-42f2-b60f-5565630dba95

as I made changes in the JavadocParagraph's implementation and added support to check for <p></p>, Semaphore CI started giving error for pgjdbc repository, indicating that it has incorrect paragraph tags' placement. My mentor @romani suggested to send a PR to pgjdbc and fix the incorrect paragraphs' placement ( checkstyle/checkstyle#15686 (comment) ).

I have tried to fix it in this PR. I have made changes in javadoc comments and tried to fix the incorrect placements. Our Check was not able to detect these incorrect changes previously but after my PR gets merged, this bug will get fixed and Check's newer version be available in the next release.

I hope my PR gets attention of pgjdbc's maintainers, thank you :)

Sorry, something went wrong.

Copy link
Member

@vlsi vlsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me.

https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#format indeed suggests there should be no starting <p>, and many OpenJDK classes even omit </p> altogether.

@vlsi vlsi merged commit ff62a0e into pgjdbc:master Oct 7, 2024
17 of 18 checks passed
@Zopsss Zopsss deleted the fix-paragraphs branch October 7, 2024 14:29
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.

None yet

3 participants