Return-Path: X-Original-To: apmail-tajo-dev-archive@minotaur.apache.org Delivered-To: apmail-tajo-dev-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id A593F10EA0 for ; Sun, 19 Jan 2014 13:18:47 +0000 (UTC) Received: (qmail 93777 invoked by uid 500); 19 Jan 2014 13:18:46 -0000 Delivered-To: apmail-tajo-dev-archive@tajo.apache.org Received: (qmail 93721 invoked by uid 500); 19 Jan 2014 13:18:45 -0000 Mailing-List: contact dev-help@tajo.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@tajo.incubator.apache.org Delivered-To: mailing list dev@tajo.incubator.apache.org Received: (qmail 93616 invoked by uid 99); 19 Jan 2014 13:18:44 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 19 Jan 2014 13:18:44 +0000 X-ASF-Spam-Status: No, hits=-2000.5 required=5.0 tests=ALL_TRUSTED,RP_MATCHES_RCVD X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO mail.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with SMTP; Sun, 19 Jan 2014 13:18:42 +0000 Received: (qmail 93486 invoked by uid 99); 19 Jan 2014 13:18:20 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 19 Jan 2014 13:18:20 +0000 Date: Sun, 19 Jan 2014 13:18:20 +0000 (UTC) From: "Hyunsik Choi (JIRA)" To: dev@tajo.incubator.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Updated] (TAJO-409) Add explored and explained annotations to Tajo function system MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 X-Virus-Checked: Checked by ClamAV on apache.org [ https://issues.apache.org/jira/browse/TAJO-409?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Hyunsik Choi updated TAJO-409: ------------------------------ Status: Patch Available (was: Open) > 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, TAJO-409_20140119_22:11:45.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)