-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Issue #14689: Prevent false positives when first sentence of Javadoc is on its own line #14690
Issue #14689: Prevent false positives when first sentence of Javadoc is on its own line #14690
Conversation
69c7787
to
a262f21
Compare
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java
Outdated
Show resolved
Hide resolved
please squash all in single commit |
4310b16
to
c311d18
Compare
Done |
c311d18
to
02f844a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks a lot for fix.
first shallow dive in PR:
...com/puppycrawl/tools/checkstyle/checks/javadoc/summaryjavadoc/InputSummaryJavadocPeriod.java
Outdated
Show resolved
Hide resolved
...ckstyle/test/chapter7javadoc/rule72thesummaryfragment/InputIncorrectSummaryJavaDocCheck.java
Outdated
Show resolved
Hide resolved
...om/puppycrawl/tools/checkstyle/checks/javadoc/summaryjavadoc/InputSummaryJavadocCorrect.java
Outdated
Show resolved
Hide resolved
@patchwork01, please resolve Checker and Pitest failures. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Items
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/SummaryJavadocCheck.java
Outdated
Show resolved
Hide resolved
741f2e9
to
6cfadae
Compare
please review if we can avoid this: https://github.com/checkstyle/checkstyle/actions/runs/8466706931/job/23196469563?pr=14690#step:6:933
if not, just run |
last testing request, please read https://github.com/checkstyle/contribution/tree/master/checkstyle-tester#basic-difference-report-with-custom-projects-list and provide such two configs and lets test on bunch of real code. Result will be diff report, we need o make sure there is not unexpected regressions. |
2afe320
to
0563051
Compare
That's fixed now.
I'm not sure what you mean. What do you want me to do? |
please read https://github.com/checkstyle/contribution/tree/master/checkstyle-tester#executing-generation Example configuration in PR description and triggering for different Check - #14743 |
GitHub, generate report |
Regression only ran against default SummaryJavadoc. We need run with change in property. |
The only meaningful config we can run on is https://github.com/checkstyle/checkstyle/pull/14690/files#diff-86ad081949df60d8dd42db875094b5df6d70aed3f23759b7520605bfc23f86beR5 If not, please share what configs you think we need to run on by means of https://github.com/search?q=+language%3AJava++%E3%80%82&type=code |
Github, generate report |
Report should have all projects.
Use the same config, but also include the US period. Based on the logic presented here, it will assume it has a space after it so I should differences between this and the other config with the default. |
The US period is the default. That's the configuration that was used in this run 5 days ago. We can set the period character explicitly, but it won't be any different. |
Github, generate report |
GitHub, generate report |
Report generation failed on phase "make_report", |
Report generation failed on phase "make_report", |
3043b4f
to
84bd50f
Compare
GitHub, generate report |
My fault, I missed this in the documentation. |
Please provide the regression of the japanese period on all projects. |
Semaphore is restarted, it was real problem after merge of unrelated PR. Should be green after restart |
GitHub, generate report |
Report generation failed on phase , |
GitHub, generate report |
Report generation failed on phase , |
GitHub, generate report |
@rnveach , done, no changes. |
@rnveach , please finish review |
GitHub, generate report |
84bd50f
to
55de62d
Compare
Handle cases where first sentence of Javadoc is on its own line.
Handle cases where first sentence of Javadoc includes a period character without whitespace after it.
original-Diff Regression config: https://gist.githubusercontent.com/patchwork01/d62651d8467212daf75aff8100e813c1/raw/ac03b5b7fbcbee95f7508e40462ce97d72dfc550/my_check.xml
jp-period-Diff Regression config: https://gist.githubusercontent.com/romani/3a9b1b47b71ad0a9f5583a738ff4710c/raw/862494acad8497fb3129d7893dd1438ebf48c7b8/my_check-pr-14690.xml
jp-period-Diff Regression projects: https://gist.githubusercontent.com/romani/edc0f152b7dd10118e6bc395bb1e62af/raw/c8cc30b749d4c27b94fa219b701120f1bca4a435/pull-14690-projects.properties
Prev-Diff Regression config: https://gist.githubusercontent.com/patchwork01/4bcb6b58b28420050538692ddedb0938/raw/4a75a7edd7e01edd0fda401cb9496f5e4b8b51b7/my_check.xml
jp-period-Diff Regression config: https://gist.githubusercontent.com/romani/3a9b1b47b71ad0a9f5583a738ff4710c/raw/862494acad8497fb3129d7893dd1438ebf48c7b8/my_check-pr-14690.xml
Diff Regression config: https://raw.githubusercontent.com/checkstyle/test-configs/main/SummaryJavadoc/japan-period/config.xml
Diff Regression projects: https://raw.githubusercontent.com/checkstyle/test-configs/main/SummaryJavadoc/japan-period/list-of-projects.properties