Re: First documentation patch



why not just put them in module.pod instead of module.pm ?
it would be better since the odds're high this doc will grow and
become quite large ...

Its personal style and preference I guess.  I've always tended to
place them in the .pm file because I tend to duel-use the details
in the METHOD section as both the guts of my documentation and the
comments above my functions (or in these cases, methods).

As the .pm files in an XS distribution need not contain a function
for each object method, that advantage is not there since there
are few 'functions' to stick headers above.

Its down to the Developers/Maintainers call, i'm flexible either
way and am happy to re-submit as .pod files if they would
prefer.

There is a purely cosmetic issue currently doing it that way such
that the headers and footers appear as "LABEL" instead of "Gtk2::Label"
if you use the .pod method.  I am absolutely certain that
if I dig a little into the .pod formatting documentation I can find
the override for that.

I'll wait until I get the nod from the maintainer as to which style
is preferable and any other comments before I continue to work my
way through the library.

Regards,


Red.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]