Return-Path: 
 <dev-return-74341-apmail-hive-dev-archive=hive.apache.org@hive.apache.org>
X-Original-To: apmail-hive-dev-archive@www.apache.org
Delivered-To: apmail-hive-dev-archive@www.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id 673AF104DC
	for <apmail-hive-dev-archive@www.apache.org>;
 Sat, 21 Dec 2013 11:36:28 +0000 (UTC)
Received: (qmail 4411 invoked by uid 500); 21 Dec 2013 11:36:20 -0000
Delivered-To: apmail-hive-dev-archive@hive.apache.org
Received: (qmail 4328 invoked by uid 500); 21 Dec 2013 11:36:15 -0000
Mailing-List: contact dev-help@hive.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:dev-help@hive.apache.org>
List-Unsubscribe: <mailto:dev-unsubscribe@hive.apache.org>
List-Post: <mailto:dev@hive.apache.org>
List-Id: <dev.hive.apache.org>
Reply-To: dev@hive.apache.org
Delivered-To: mailing list dev@hive.apache.org
Received: (qmail 4313 invoked by uid 500); 21 Dec 2013 11:36:11 -0000
Delivered-To: apmail-hadoop-hive-dev@hadoop.apache.org
Received: (qmail 4308 invoked by uid 99); 21 Dec 2013 11:36:10 -0000
Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28)
    by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 21 Dec 2013 11:36:10 +0000
Date: Sat, 21 Dec 2013 11:36:09 +0000 (UTC)
From: "Lefty Leverenz (JIRA)" <jira@apache.org>
To: hive-dev@hadoop.apache.org
Message-ID: <JIRA.12675811.1382708766603.76534.1387625769925@arcas>
In-Reply-To: <JIRA.12675811.1382708766603@arcas>
References: <JIRA.12675811.1382708766603@arcas>
Subject: [jira] [Commented] (HIVE-5652) Improve JavaDoc of UDF class
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394


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

Lefty Leverenz commented on HIVE-5652:
--------------------------------------

Good improvements.  Just two trivial suggestions:

(1) Add a period before the closing parenthesis in the second sentence here: 
{code}
+ * <li>{@code public String evaluate(List<Integer> a);} (Note that Hive Arrays are represented as
+ * {@link java.util.List Lists} in Hive. So an {@code
+ * ARRAY<int>} column would be passed in as a {@code List<Integer>})</li>
{code}

(2) Omit "the" here (line 8 of the patch, unchanged text):
{code}
 /**
  * A User-defined function (UDF) for the use with Hive.
{code}

> Improve JavaDoc of UDF class
> ----------------------------
>
>                 Key: HIVE-5652
>                 URL: https://issues.apache.org/jira/browse/HIVE-5652
>             Project: Hive
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Lars Francke
>            Assignee: Lars Francke
>            Priority: Trivial
>         Attachments: HIVE-5652.1.patch
>
>
> I think the JavaDoc for the UDF class can be improved. I'll attach a patch shortly.



--
This message was sent by Atlassian JIRA
(v6.1.4#6159)