Richard Foley wrote on p5p:
>[...]It seems to me, perldoc should have another command line argument,
>unless I'm not quite understanding the spec and perldoc correctly.[...]
[and a discussion of "=for foo bar" ensued]

Anything to do with Pod, perldoc, or the pod formatters belongs on the 
pod-people list, not p5p.

But anyway, you happen to have caught me at a great time for this.  I'm 
about to cook up the perldoc <-> Pod::Simple interface, and I think I could 
try adding stuff to accodomate something so that you could say "I want to 
format the '=for foo ...' sections too", without requiring that the 
formatter even know that such sections weren't just normal paragraphs.

There's one caveat: complication is that the first thing after an =over 
MUST be an =item (if there's going to be any =item's in that over 
block).  So this is bad:

=over

=begin private

=item

=end private

A more pragmatic consideration is that you have to tell people, pretty 
visibly, something like "If you want to see the private methods, format 
this with C<perldoc -whatever=private>", etc.

I appreciate what you want to do, but for sake of simplicity, I'd rather 
just have one big section with all the public methods, then another with 
all the private methods, and no special markup involved.  It's just a 
question of ordering; and at least in classes I write, I can freely 
reshuffle the other of methods in the source code so that I can have docs 
before each and still have it all come out in an easy-to-read order.

--
Sean M. Burke    http://search.cpan.org/author/sburke/

Reply via email to