tajo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "DaeMyung Kang (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (TAJO-409) Add explored and explained annotations to Tajo function system
Date Thu, 16 Jan 2014 08:35:22 GMT

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

DaeMyung Kang commented on TAJO-409:
------------------------------------

[~epsilon] currently, please just ignore Findbugs. :)
the rules will be changed.

> 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)

Mime
View raw message