flink-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FLINK-514) Fix invalid Javadoc references
Date Sun, 28 Sep 2014 09:14:33 GMT

    [ https://issues.apache.org/jira/browse/FLINK-514?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14151056#comment-14151056
] 

ASF GitHub Bot commented on FLINK-514:
--------------------------------------

Github user rmetzger commented on the pull request:

    https://github.com/apache/incubator-flink/pull/129#issuecomment-57079721
  
    Perfect, thank you!
    Good javadocs are very important, in particular the user-facing public methods.
    
    I was thinking about adding something like a "quality assurance" bot to our github pull
requests. One task of this bot could be a check that a pull request is not adding more javadoc
errors. Hadoop has something similar for the JIRA patches: https://issues.apache.org/jira/secure/ViewProfile.jspa?name=hadoopqa


> Fix invalid Javadoc references
> ------------------------------
>
>                 Key: FLINK-514
>                 URL: https://issues.apache.org/jira/browse/FLINK-514
>             Project: Flink
>          Issue Type: Improvement
>            Reporter: GitHub Import
>            Assignee: Daniel Warneke
>            Priority: Minor
>              Labels: github-import
>             Fix For: pre-apache
>
>
> When building the project, there are a lot of warnings, because of invalid Javadoc references.
One major source of this is imo that Eclipse does not complain with the default settings.
Let's make sure to keep it in mind for future doc comments and fix the bad ones (although
low priority for the system itself, I think it affects the perception of the code quality).
> ---------------- Imported from GitHub ----------------
> Url: https://github.com/stratosphere/stratosphere/issues/514
> Created by: [uce|https://github.com/uce]
> Labels: build system, enhancement, simple-issue, 
> Created at: Wed Feb 26 15:35:50 CET 2014
> State: open



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message