Juan Camacho ha scritto:
On 5/7/07, Matt S Trout <[EMAIL PROTECTED]> wrote:
On Mon, May 07, 2007 at 12:09:49PM -0400, Juan Camacho wrote:
> On 5/7/07, Matt S Trout <[EMAIL PROTECTED]> wrote:
>
> >in MyApp.pm - you were confusing the 'Controller::Foo' key that specifies > >which component MyApp-level config is for and the 'Controller::FormBuilder' > >key that specifies C::C::FB-specific config options within a controller. > >The names are sufficiently similar I'm not blaming you though - Juan, maybe
> >a doc tweak or a clearer name is in order?
> >
>
> Yes, I'll clarify the documentation and maybe include something about
> a Controller base class as a best practice suggestion. Having it in
> the synopsis section doesn't seem to provide enough descriptive info
> it seems ;)

I think making the key 'FormBuilder' instead of 'Controller::FormBuilder'
would probably also help people a lot; I understand your desire to keep the
C::FB config params namespaced to avoid clashes but it -is- confusing, I
have to think about it when I'm helping people using FB :)


No problem. I'll keep the Controller::FormBuilder for backward
compatibility of course.

_______________________________________________
List: [email protected]
Listinfo: http://lists.rawmode.org/mailman/listinfo/catalyst
Searchable archive: http://www.mail-archive.com/[email protected]/
Dev site: http://dev.catalyst.perl.org/



I like the Controller::FormBuilder key. That was not the bit that confused me.

The really confusing bit is, as already noted, the synopsis section, where one just reads the bit of code but no hint is given as to where that snippet belongs.

I assumed that the config code snipped could belong in MyApp.pm because I thought it would set some sort of default for C::FB. Probably I didn't realize I was thinking about C::FB more as a plugin than as a base class...

Given the information provided now, I think that the base class approach is the best way to go, and should definitely included in the docs (or maybe even in the synopsis section).

--
Marcello Romani
Responsabile IT
Ottotecnica s.r.l.
http://www.ottotecnica.com

_______________________________________________
List: [email protected]
Listinfo: http://lists.rawmode.org/mailman/listinfo/catalyst
Searchable archive: http://www.mail-archive.com/[email protected]/
Dev site: http://dev.catalyst.perl.org/

Reply via email to