On Mon, 2005-11-21 at 18:29 +0000, Aaron Trevena wrote:
> Hi all,
>
> Osfamaron on #london.pm sent me some feedback about the 2.10
> documentation, obviously it doesn't necessarily all apply now but
> there are still some useful comments that still apply.
Great comments. See below for a couple of specifics.
> ---------- Forwarded message ----------
> From: Hakim Cassimally <[EMAIL PROTECTED]>
> * 'We use a link table called "handpump" to relate pubs to beers'.
> I'm a Brit and this confuses me. I know this is a historic example
> from real code, but
> might be worth changing to something like pubs_to_beers, just a thought.
Hmm, but then ...
BeerDB->config->{loader}->relationship($_) for (
"a brewery produces beers",
"a style defines beers",
"a pub has beers on pubs_to_beers");
... just doesn't read as well does it? Perhaps it's better to encourage
all users to frequent the type of pubs that DO have handpumps :)
> * Links: doesn't tell you which page to read next. You have to go
> back to Maypole::Manual to see that it's Maypole::Manual::Model.
> Oh, that's because perldoc renders them as the pretty text, bag of
> shite. Either fix perldoc or add C<> tags for these? Or just change
> to
> Next Maypole Model Classes (L<Maypole::Manual::Model>) ?
What a quaint idea, reading the docs with perldoc! But more seriously,
be very careful about changes here. Whatever CPAN does is weird and
wonderful and it took SimonF a couple of goes to get the links to work
properly when browsing on CPAN.
> Maypole::Manual::View
> ======================
> * No version number
> * Good, I like the way that it gives some meaty TT examples rather
> than just referring to the TT site.
I agree with this. What I would have liked when I started was a meaty
explanation about the CGI and mod_perl concepts that Maypole uses (or
even a pointer to a good tutorial). I already knew TT, but didn't (and
still don't) know anything about mod_perl. That sometimes makes some of
the explanations in Maypole's manual less than clear. Like 'requests'
for example :)
Cheers, Dave
-------------------------------------------------------
This SF.Net email is sponsored by the JBoss Inc. Get Certified Today
Register for a JBoss Training Course. Free Certification Exam
for All Training Attendees Through End of 2005. For more info visit:
http://ads.osdn.com/?ad_id=7628&alloc_id=16845&op=click
_______________________________________________
Maypole-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/maypole-devel
