> -----Original Message----- > From: Jonathan Yu [mailto:[email protected]] > Sent: Friday, September 04, 2009 10:16 PM > To: Burak Gürsoy > Cc: Shlomi Fish; [email protected] > Subject: Re: What Would you like to see in a CPAN Distro Manager? >
> > I was doing that before PBP, it's beter to leave the code alone and > send the docs after end IMHO. Since I know that Pod is after that I can > get it without parsing with Pod::Simple or I can just do > [SHIFT]+[PgDown] to get all of it. Or maybe I just want to add > something before "=cut" (which I do when building distros) and I stil > don't need to parse Pod to do that. Inline Pod is evil. I hate it > everytime I see it. Makes it hard ro read code too. But again, just > IMHO & $0.02. > I think the problem with doing that, for me, is that I'd forget to > update stuff and then my docs would become even more out of sync with > my code, which is a pretty bad thing. It's bad enough people don't > update comments that are right next to the code in question; when it > comes to docs... I imagine it'd get even worse. In my previous $job we had inline pods and they were never updated. In fact there were some zombie pods with no corresponding code :) And I stil think that it makes code hard to read and does not help As a comment. Just not my taste. > Redoing stuff for the purposes of making things easier for a computer > seems backwards to me. After all, computers are supposed to do work > for /us/ -- they're faster, more consistent, etc. So leave programmers > to do what programmers do, and let the computers worry about > extracting inline POD. :-) Ok, I'll give you a practical test case. Forget everything else, I'm doing 2 things with the Pod while building a distro. 1) Add Author/Copyright/License sections automatically to all modules (before =cut) (they don't have these in VCS) 2) Remove all Pod and bundle a monolithic (or merged) version of the Module (which has lots of sub modules) in a separate directory. I'm doing this for two of my modules I don't need to parse Pod to do these if it's after __END__. But then again, it's my choice of doing things :) -Burak
