[jira] [Commented] (TAJO-409) Add explored and explained annotations to Tajo function system

["Tajo QA (JIRA)" <ji...@apache.org>]

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

Tajo QA commented on TAJO-409:
------------------------------

{color:red}*-1 overall.*{color:red}  Here are the results of testing the latest attachment 
  http://issues.apache.org/jira/secure/attachment/12623296/TAJO-409.patch
  against master revision 69700bf.

    {color:green}+1 @author.  The patch does not contain any @author tags.{color:green}

    {color:green}+1 tests included.  The patch appears to include 2 new or modified test files.{color:green}

    {color:green}+1 javac.  The applied patch does not increase the total number of javac compiler warnings.{color:green}

    {color:green}+1 javadoc.  The applied patch does not increase the total number of javadoc warnings.{color:green}

    {color:green}+1 checkstyle.  The patch generated 0 code style errors.{color:green}

    {color:red}-1 findbugs.  The patch appears to introduce 695 new Findbugs (version 1.3.9) warnings.{color:red}

    {color:green}+1 release audit.  The applied patch does not increase the total number of release audit warnings.{color:green}

    {color:green}+1 core tests.  The patch passed unit tests in tajo-catalog/tajo-catalog-client tajo-catalog/tajo-catalog-common tajo-catalog/tajo-catalog-server tajo-core/tajo-core-backend.{color:green}

Test results: https://builds.apache.org/job/PreCommit-TAJO-Build/46//testReport/
Findbugs warnings: https://builds.apache.org/job/PreCommit-TAJO-Build/46//artifact/incubator-tajo/patchprocess/newPatchFindbugsWarningstajo-core-backend.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-TAJO-Build/46//artifact/incubator-tajo/patchprocess/newPatchFindbugsWarningstajo-catalog-client.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-TAJO-Build/46//artifact/incubator-tajo/patchprocess/newPatchFindbugsWarningstajo-catalog-common.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-TAJO-Build/46//artifact/incubator-tajo/patchprocess/newPatchFindbugsWarningstajo-catalog-server.html
Console output: https://builds.apache.org/job/PreCommit-TAJO-Build/46//console

This message is automatically generated.

> Add explored and explained annotations to Tajo function system
> --------------------------------------------------------------
>
>                 Key: TAJO-409
>                 URL: https://issues.apache.org/jira/browse/TAJO-409
>             Project: Tajo
>          Issue Type: Sub-task
>          Components: function/udf
>            Reporter: Hyunsik Choi
>            Assignee: SeongHwa Ahn
>             Fix For: 0.8-incubating
>
>         Attachments: TAJO-409.patch
>
>
> Currently, it is hard for developers to add explanations to functions and user-defined functions. Java has annotation feature. We can make function system more explored and explained with java annotations.
> h3. Proposal
> A function should have the following annotations
>  * function name (string) - optional
>    ** If a function is user-defined, this field is ignored.
>    ** the function name of user-defined function is given when it is registered.
>  * synonyms (string []) - optional
>    ** If a function is user-defined, this field is ignored.
>    ** One or more aliases can be described.
>  * description (string)
>    ** *one* line explanation for a function
>  * detail (string) - optional
>    ** more explanations which can be two or more lines
>  * example
>    ** what are parameters and what is a result.
> Function signatures can be derived from function name, parameters, and return types.



--
This message was sent by Atlassian JIRA
(v6.1.5#6160)