-
Notifications
You must be signed in to change notification settings - Fork 13.5k
[FLINK-7190] Activate checkstyle flink-java/* #4343
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
Conversation
This is the last commit of series. It enables the stricter checkstyle. So should be merged last. |
What if we first split the suppressions files as with |
@greghogan I agree, expanding the suppression files would be nice. |
tools/maven/suppressions-java.xml
Outdated
checks="NewlineAtEndOfFile|RegexpSingleline|TodoComment|RedundantImport|ImportOrder|RedundantModifier|JavadocMethod|JavadocParagraph|JavadocType|JavadocStyle|PackageName|TypeNameCheck|ConstantNameCheck|StaticVariableNameCheck|MemberNameCheck|MethodNameCheck|ParameterName|LocalFinalVariableName|LocalVariableName|LeftCurly|UpperEll|FallThrough|reliefPattern|SimplifyBooleanExpression|EmptyStatement|ModifierOrder|EmptyLineSeparator|WhitespaceAround|WhitespaceAfter|NoWhitespaceAfter|NoWhitespaceBefore|OperatorWrap|ParenPad"/> | ||
files="ExecutionEnvironment\.java" | ||
checks="JavadocParagraph"/> | ||
<suppress |
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.
why are these excluded?
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.
In NestedMethodAnalyzer:358-362, there is an intentional fall through which I would require a bit bigger refactoring to eliminate.
For the ExecutionEnvironment it was because we linked in javadoc to class from a package that flink-java does not depend on. I've checked the generated docs, and the links do not work nevertheless, so I removed the suppression and changed {@link
to {@code
.
The switch statements can be modified to be checkstyle compliant with few changes.
|
16d221b
to
b1f5abd
Compare
merging. |
Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration.
If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the How To Contribute guide.
In addition to going through the list, please provide a meaningful description of your changes.
General
Documentation
Tests & Build
mvn clean verify
has been executed successfully locally or a Travis build has passed