You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-issues@hadoop.apache.org by "Dinesh Chitlangia (JIRA)" <ji...@apache.org> on 2018/10/10 04:24:00 UTC
[jira] [Updated] (HADOOP-15721) Disable checkstyle javadoc warnings
for test classes
[ https://issues.apache.org/jira/browse/HADOOP-15721?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Dinesh Chitlangia updated HADOOP-15721:
---------------------------------------
Attachment: HADOOP-15721.001.patch
Status: Patch Available (was: Open)
> Disable checkstyle javadoc warnings for test classes
> ----------------------------------------------------
>
> Key: HADOOP-15721
> URL: https://issues.apache.org/jira/browse/HADOOP-15721
> Project: Hadoop Common
> Issue Type: Bug
> Reporter: Shane Kumpf
> Assignee: Dinesh Chitlangia
> Priority: Minor
> Labels: newbie
> Attachments: HADOOP-15721.001.patch
>
>
> The current checkstyle rules with throw a warning if the javadoc is missing for a test class which is of minimal value. We should consider disabling this check and allowing contributors to comment test classes as they see fit.
> Here is an example:
> {code:java}
> ./hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/test/java/org/apache/hadoop/yarn/server/nodemanager/containermanager/linux/runtime/MockLinuxContainerRuntime.java:27:public class MockLinuxContainerRuntime implements LinuxContainerRuntime {: Missing a Javadoc comment. [JavadocType]{code}
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: common-issues-help@hadoop.apache.org