--- drieux <[EMAIL PROTECTED]> wrote: > ... > > Solving 'what should be in the pod' as opposed to > 'in code comments' > ...
POD doc'n in CPAN modules is basically of the "here's how to use this code" variety, so taking that is the model, here's what I'm thinking about that distinction. If it's about how to USE the code, such as the arguments expected by a function, that's POD doc'n. If it's something about the internals that only the developer needs to know, such as more explanation of a particularly gnarly algorithm, then it needn't and probably shouldn't be POD. Don't confuse your audience with things they don't need to know. ===== "Now it's over, I'm dead, and I haven't done anything that I want; or, I'm still alive, and there's nothing I want to do." - They Might Be Giants, http://www.tmbg.com __________________________________________________ Do You Yahoo!? Yahoo! - Official partner of 2002 FIFA World Cup http://fifaworldcup.yahoo.com -- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
