[PIG-3405] Top UDF documentation indicates improper use

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 0.10.0
• Fix Version/s: 0.12.0
• Component/s: documentation

Environment

Javadoc and pig tutorial

• Assignee: Aniket Namadeo Mokashi
• Reporter: Keith Wyss
• Created: 01/Aug/13 16:42
• Updated: 14/Oct/13 16:46
• Resolved: 16/Aug/13 19:07

Description

The documentation in both the source code javadoc: http://svn.apache.org/repos/asf/pig/trunk/src/org/apache/pig/builtin/TOP.java and the Apache Pig Reference manual: http://pig.apache.org/docs/r0.8.1/piglatin_ref2.html#TOP indicates that the index that is passed to the TOP UDF should be 1-indexed.

Reading the code and testing the results, this is false. Zero-indexing gives the correct behavior. Users should not be betrayed by the official documentation.