pig-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "MIYAKAWA Taku (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (PIG-3112) Errors and lacks in document "User Defined Functions"
Date Tue, 01 Jan 2013 09:58:12 GMT

     [ https://issues.apache.org/jira/browse/PIG-3112?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel

MIYAKAWA Taku updated PIG-3112:

    Status: Patch Available  (was: Open)

A patch which fixes the issue.
> Errors and lacks in document "User Defined Functions"
> -----------------------------------------------------
>                 Key: PIG-3112
>                 URL: https://issues.apache.org/jira/browse/PIG-3112
>             Project: Pig
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.10.0
>            Reporter: MIYAKAWA Taku
>              Labels: documentation, patch
>         Attachments: PIG-3112.patch
> This patch fixes following errors in the document "User Defined Functions".
> # Malformed type parameters such as "List (FuncSpec)" and "new ArrayList (FuncSpec) ()"
> # "Reporting Progress" subsection describes EvalFunc#progress, but the example program
calls PigProgressable#progress. The program works, but it would be better to be consistent
with the description calling EvalFunc#progress.
> # Several sentences about LoadFunc and StoreFunc refer to the current load/store API
as "the new API" such as "The meaning of putNext() has not changed ... - in the new API, this
is the method ...". It is not good because the document is not about migration from the old
API. The patch removes those words.
> # "Passing Configurations to UDFs" subsection refers to "describeSchema" method, but
it does not exist. The patch replaces it with "checkSchema" method.
> # Updates links
> #* [Using Java Reflection|http://www.oracle.com/technetwork/articles/java/javareflection-1536171.html]
> #* [javadoc - The Java API Documentation Generator|http://docs.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html]
> #* [How to Contribute to Pig|https://cwiki.apache.org/confluence/display/PIG/HowToContribute]
> # Fixes typos
> #* "implemented in -three- +five+ languages: Java, Python, JavaScript, Ruby and Groovy"
> #* "The exact signature of the function should +be+ clear from its documentation"
> #* The EvalFunc -function- +class+ provides a progress function
> #* "Inside -EvalFunc- +exec method+, you can assume that these files already exist in
distributed cache"
> #* "throw +new+ IOException(...);"
> #* "throw -newIOException- +new IOException+ (...);"
> #* "throw new -OException- +IOException+ (...);"
> #* "to use the UPPER -command- +function+ "
> #* " -Square- +square+ - Square of a number of any data type"
> #* "ships the required scriptengine (-js- +Rhino+) to interpret it"
> The patch creates a new section "Using Short Names" including two subsections:
> * "Import Lists" moved from "Eval Functions": this subsection should be out of "Eval
Functions", because import lists can be used for load/store functions, and the example program
imports a load function.
> * "Defining Aliases" describing DEFINE statement: it seems good to explain the statement
here, next to the description of import lists. DEFINE statement currently has not been referred
from the document.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

View raw message