Re: [Maypole-dev] Maypole API documentation

From: Simon Flack (sf at flacks.net)
Date: Sun Sep 26 2004 - 22:09:04 BST


On Sun, 26 Sep 2004 22:48:39 +0200, Sebastian Riedel wrote
> Simon Flack:
> > It would be great to have a bit more documentation for the next release
(2.0?)
> > . So I've drafted up some documentation for the Maypole request API. It
should
> > probably replace the POD in Maypole.pm since it mostly duplicates
information
> > in the doc/ folder. With that in mind I have some other
> > observations/suggestions:
> >
> > 1. It would be good to move the user guide in docs/ into the lib/ folder
under
> > the Maypole::Tutorial/Manual namespace. This will make sure the user guide
is
> > installed along with the rest of Maypole, and the API docs/user guide will
be
> > able to easily refer to one another with the standard L<NAME> syntax.
> good idea, done.
> >
> > 2. The code bypasses the accessors in may places (see: grep -r '$r->{'
trunk/)
> > . It would be quite nice if Maypole itself used the accessors/mutators it
> > provides.
> Would be nice, but not very important...

Maybe not now, but it'll get more important as more people start using it.

> > =head3 setup
> >
> > My::App->setup();
> >
> > Initialise the maypole application and model classes. Your application
should
> > call this after setting configuration via L<"config">

Just noticed that should be:

=head3 setup

    My::App->setup($data_source, $user, $password, \%attr);

> Very nice! Added it, thanks.

Thanks. The indenting is a bit broken on setup, debug and template_args.

> btw. the Maypole web site is now http://maypole.perl.org

Excellent, and it's a wiki!

--simonflk

_______________________________________________
maypole-dev mailing list
maypole-dev at lists.netthink.co.uk
http://lists.netthink.co.uk/listinfo/maypole-dev



This archive was generated by hypermail 2.1.3 : Thu Feb 24 2005 - 22:25:56 GMT