Skip to content

Fix JavadocParagraph #2302

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

Closed
wants to merge 3 commits into from
Closed

Conversation

Pankraz76
Copy link
Contributor

@Pankraz76 Pankraz76 commented May 7, 2025

@Pankraz76
Copy link
Contributor Author

[INFO] BUILD SUCCESS

Copy link
Contributor

@gnodet gnodet left a comment

Choose a reason for hiding this comment

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

If you're using a tool, add it to the PR.
If you want to enforce a checkstyle rule, you need to enabled it.

In this very case, I have a hard time to see what it fixes, and what good it brings. This additional empty lines helps readability of the doc imho.

@gnodet gnodet changed the title Pull apache#2302: Modernize codebase - fix JavadocParagraph Fix JavadocParagraph May 7, 2025
@Pankraz76 Pankraz76 changed the title Fix JavadocParagraph Fix JavadocParagraph May 7, 2025
@Pankraz76
Copy link
Contributor Author

Pankraz76 commented May 7, 2025

If you want to enforce a checkstyle rule, you need to enabled it.

Where to find it, please?

I did not found it locally, assuming it comes from cloud, as I saw some SCV link recently.

image

@Pankraz76 Pankraz76 marked this pull request as ready for review May 7, 2025 20:57
Copy link
Contributor

@gnodet gnodet left a comment

Choose a reason for hiding this comment

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

This hinders readability.
To keep readability, maybe put <p> on its own line.
Also, if you want to enforce checkstyle rules, this need to be done in the checkstyle config.

@Pankraz76
Copy link
Contributor Author

Pankraz76 commented May 9, 2025

This hinders readability.
To keep readability, maybe put <p> on its own line.

yes.

Also, if you want to enforce checkstyle rules, this need to be done in the checkstyle config.

yes, where are the rules please? Maybe here?

@Pankraz76 Pankraz76 marked this pull request as draft May 9, 2025 20:12
@Pankraz76
Copy link
Contributor Author

should add rule via checkstyle and then only make ci happy.

@Pankraz76 Pankraz76 force-pushed the fix-javadocparagraph branch from 1252c1d to e58f596 Compare May 11, 2025 14:56
@Pankraz76
Copy link
Contributor Author

Pankraz76 commented May 11, 2025

s&r = error

before: Files changed 135

ide fix = save

after: Files changed 49

@Pankraz76 Pankraz76 requested a review from gnodet May 11, 2025 15:00
@Pankraz76
Copy link
Contributor Author

less then 50 might be acceptable.

@Pankraz76 Pankraz76 marked this pull request as ready for review May 11, 2025 15:01
@Pankraz76 Pankraz76 closed this May 20, 2025
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