You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@lucy.apache.org by goran kent <go...@gmail.com> on 2011/10/27 09:18:23 UTC

[lucy-user] Minor online doc bugs

Hi,

Just a heads up wrt the online docs which might be a minor impediment
to new users:

http://incubator.apache.org/lucy/docs/perl/Lucy/Docs/Tutorial/BeyondSimple.html
my $doc = slurp_and_parse_file($filename);
# should read:
my $doc = parse_file($filename);

http://incubator.apache.org/lucy/docs/perl/Lucy/Docs/Tutorial/Simple.html
refers to "category => $category", but there is no field or code for category

There are also POD errors on the Simple.html page:
"Hey! The above document had some coding errors, which are explained below:

Around line 154:

    Deleting unknown formatting code M<>"

Re: [lucy-user] Minor online doc bugs

Posted by Marvin Humphrey <ma...@rectangular.com>.
On Mon, Oct 31, 2011 at 08:38:20PM -0500, Peter Karman wrote:
> goran kent wrote on 10/27/11 2:18 AM:
> > Hi,
> > 
> > Just a heads up wrt the online docs which might be a minor impediment
> > to new users:
> > 
> > http://incubator.apache.org/lucy/docs/perl/Lucy/Docs/Tutorial/BeyondSimple.html
> > my $doc = slurp_and_parse_file($filename);
> > # should read:
> > my $doc = parse_file($filename);
> > 
> > http://incubator.apache.org/lucy/docs/perl/Lucy/Docs/Tutorial/Simple.html
> > refers to "category => $category", but there is no field or code for category
> > 
> > There are also POD errors on the Simple.html page:
> > "Hey! The above document had some coding errors, which are explained below:
> > 
> > Around line 154:
> > 
> >     Deleting unknown formatting code M<>"
> 
> thanks. fixed in trunk as r1195756.

Yes, thanks Goran.

A lot of the people associated with Lucy care deeply about providing good
documentation.  We have tests for some of our sample code, but it is hard to
get everything right in all snippets for the tutorial documentation without
actually going through the tutorial (which of course the developers cannot do
for each release).  I for one really appreciate it when users chip in with
fixes like these that I cannot realistically get to myself.

Cheers,

Marvin Humphrey

Re: [lucy-user] Minor online doc bugs

Posted by Peter Karman <pe...@peknet.com>.
goran kent wrote on 10/27/11 2:18 AM:
> Hi,
> 
> Just a heads up wrt the online docs which might be a minor impediment
> to new users:
> 
> http://incubator.apache.org/lucy/docs/perl/Lucy/Docs/Tutorial/BeyondSimple.html
> my $doc = slurp_and_parse_file($filename);
> # should read:
> my $doc = parse_file($filename);
> 
> http://incubator.apache.org/lucy/docs/perl/Lucy/Docs/Tutorial/Simple.html
> refers to "category => $category", but there is no field or code for category
> 
> There are also POD errors on the Simple.html page:
> "Hey! The above document had some coding errors, which are explained below:
> 
> Around line 154:
> 
>     Deleting unknown formatting code M<>"

thanks. fixed in trunk as r1195756.

-- 
Peter Karman  .  http://peknet.com/  .  peter@peknet.com