I think an example in the docs is wrong

[Paul Houle <on...@gmail.com>]

I recently wrote a load function and to get started I cut-n-pasted from the
SimpleTextLoader example on the page

http://pig.apache.org/docs/r0.11.1/udf.html#load-store-functions

This contains the following code:

            boolean notDone = in.nextKeyValue();
            if (notDone) {
                return null;
            }

when data is available,  notDone is true,  and then null gets returned
rather than proceeding to process the row.  Putting a ! operator in
there quickly cleared up the problem.  I've seen the problem too in
other versions of the doc.

It would be nice to get this fixed so other people don't make this
mistake I made.

Is there an issue tracking system where I should put things like this?

Re: I think an example in the docs is wrong

[Thejas Nair <th...@hortonworks.com>]

Yes, that needs fixing.
Yes, please file a bug report on JIRA as suggested. See guide on
contributing to pig -
https://cwiki.apache.org/confluence/display/PIG/HowToDocument

To understand how the document is generated, please see -
https://cwiki.apache.org/confluence/display/PIG/HowToDocument
Regarding this particular fix, the change would need to go into -
./src/docs/src/documentation/content/xdocs/udf.xml


On Thu, Aug 8, 2013 at 7:28 PM, Pradeep Gollakota <pr...@gmail.com>wrote:

> I believe the procedure is to file a bug report on JIRA and set the
> component field to 'documentation'.
>
> Pig veterans, please correct me if I'm wrong.
>
>
> On Thu, Aug 8, 2013 at 10:19 PM, Paul Houle <on...@gmail.com> wrote:
>
> > I recently wrote a load function and to get started I cut-n-pasted from
> the
> > SimpleTextLoader example on the page
> >
> > http://pig.apache.org/docs/r0.11.1/udf.html#load-store-functions
> >
> > This contains the following code:
> >
> >             boolean notDone = in.nextKeyValue();
> >             if (notDone) {
> >                 return null;
> >             }
> >
> > when data is available,  notDone is true,  and then null gets returned
> > rather than proceeding to process the row.  Putting a ! operator in
> > there quickly cleared up the problem.  I've seen the problem too in
> > other versions of the doc.
> >
> > It would be nice to get this fixed so other people don't make this
> > mistake I made.
> >
> > Is there an issue tracking system where I should put things like this?
> >
>

Re: I think an example in the docs is wrong

[Pradeep Gollakota <pr...@gmail.com>]

I believe the procedure is to file a bug report on JIRA and set the
component field to 'documentation'.

Pig veterans, please correct me if I'm wrong.


On Thu, Aug 8, 2013 at 10:19 PM, Paul Houle <on...@gmail.com> wrote:

> I recently wrote a load function and to get started I cut-n-pasted from the
> SimpleTextLoader example on the page
>
> http://pig.apache.org/docs/r0.11.1/udf.html#load-store-functions
>
> This contains the following code:
>
>             boolean notDone = in.nextKeyValue();
>             if (notDone) {
>                 return null;
>             }
>
> when data is available,  notDone is true,  and then null gets returned
> rather than proceeding to process the row.  Putting a ! operator in
> there quickly cleared up the problem.  I've seen the problem too in
> other versions of the doc.
>
> It would be nice to get this fixed so other people don't make this
> mistake I made.
>
> Is there an issue tracking system where I should put things like this?
>