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.

Sign up for GitHub

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

Jump to bottom

Enable Checkstyle's JavadocStyle module #451

Merged
merged 3 commits into from
Jan 23, 2023
Merged

Enable Checkstyle's JavadocStyle module #451

merged 3 commits into from
Jan 23, 2023

Conversation

rickie
Copy link
Member

@rickie rickie commented Jan 6, 2023 •
edited
Loading

Suggested commit message:

Enable Checkstyle's `JavadocStyle` module (#451)

See: 
- https://checkstyle.org/config_javadoc.html#JavadocStyle
- https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.html

@rickie rickie mentioned this pull request Jan 6, 2023
Merged
1 task
@github-actions
Copy link

github-actions bot commented Jan 6, 2023

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

@rickie rickie requested review from Badbond and Stephan202 January 6, 2023 15:43
@rickie rickie added the chore A task not related to code (build, formatting, process, ...) label Jan 6, 2023
@rickie rickie added this to the 0.8.0 milestone Jan 6, 2023
Stephan202
Stephan202 approved these changes Jan 6, 2023
View reviewed changes
Copy link
Member

@Stephan202 Stephan202 left a comment

Choose a reason for hiding this comment

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

✨

Badbond
Badbond approved these changes Jan 23, 2023
View reviewed changes
Copy link
Member

@Badbond Badbond left a comment

Choose a reason for hiding this comment

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

Might be nice to also enable checkEmptyJavadoc as it is disabled by default.

@Stephan202
Copy link
Member

Good point @Badbond. Adding checkEmptyJavadoc SGTM. @rickie shall we add it to this PR?

@rickie
Copy link
Member Author

rickie commented Jan 23, 2023

Yes will do!

@rickie rickie force-pushed the rossendrijver/checkstyle-module branch from a32ae2b to 04be666 Compare January 23, 2023 09:23
@github-actions
Copy link

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

@rickie
Copy link
Member Author

rickie commented Jan 23, 2023

It found a missing one, added a proposal.

@github-actions
Copy link

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Stephan202
Stephan202 reviewed Jan 23, 2023
View reviewed changes
...-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/PrimitiveComparisonTest.java Outdated
@@ -12,6 +12,8 @@
// XXX: Can we perhaps work-around this by describing the fixes in reverse order?
final class PrimitiveComparisonTest {
/**
* Identification test for primitive {@code byte} comparisons.
Copy link
Member

Choose a reason for hiding this comment

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

Proposal to stick with the usual grammatical form:

Suggested change
* Identification test for primitive {@code byte} comparisons.
* Tests the identification of {@code byte} comparisons for which boxing can be avoided.

@github-actions
Copy link

Looks good. No mutations were possible for these changes.
Mutation testing report by Pitest. Review any surviving mutants by inspecting the line comments under Files changed.

Stephan202
Stephan202 approved these changes Jan 23, 2023
View reviewed changes
Copy link
Member

@Stephan202 Stephan202 left a comment

Choose a reason for hiding this comment

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

🚀

Badbond
Badbond approved these changes Jan 23, 2023
View reviewed changes
Copy link
Member

@Badbond Badbond left a comment

Choose a reason for hiding this comment

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

Thanks for the tweakz! 👍

@rickie rickie merged commit c212b9a into master Jan 23, 2023
@rickie rickie deleted the rossendrijver/checkstyle-module branch January 23, 2023 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Badbond Badbond Badbond approved these changes

@Stephan202 Stephan202 Stephan202 approved these changes

Assignees
No one assigned
Labels
chore A task not related to code (build, formatting, process, ...)
Milestone
0.8.0
Development

Successfully merging this pull request may close these issues.
3 participants
@rickie @Stephan202 @Badbond