#perl
08 November 2007
Total 27 pages. You are browsing page 27/27.
First :: Prev :: [...] [23] [24] [25] [26] [27] :: Next :: Last
23:53 <****> bbeattie: What happens when you close the socket?
23:53 <****> Hm. Doesn't it lessen labour to have the documentation for a method with the method? Seems somewhat strained to separate it out.
23:54 <****> ChibaPet: No, it makes reading the code excessively difficult.
23:54 <****> ChibaPet: Documentation in general, and specifically pod is for *users*.
23:54 <****> Um.
23:55 <****> buu: if I terminate via the telnet side the perl read() never notices. What is happening is it appears once it connects the perl read never gets or can send data through the socket.
23:55 <****> People reading the source code are unlikely to be interested in such things.
23:55 <****> Right. I've been programming for ages, and having documentation right there with the code is quite nice. As for pod, if my users are using my modules, then my users want my methods documented. What a silly argument.
23:55 <****> People don't need to read the source code if the documentation suffices.
23:55 <****> Yes, so why does it matter where the documentation is?
23:55 <****> ChibaPet: it's a matter of personal preference in either case
23:55 <****> They are far more likely to read only the documentation.
23:56 <****> If they have already read the documentation and are resorting to reading the actual source code, they are unlikely to be interested in having to reread the documentation that wasn't sufficient.
23:56 <****> Anyway, you've missed my point. I'm not asking whether or not doing that is good. I'm asking how to inline it, and whether there's an example or not. It'll be easier for *me* to document each method right there at the method.
23:56 <****> CORRECT. The inlining is for *me*.
23:56 <****> Pah.
23:57 <****> bbeattie: Can you consistently reproduce it?
23:57 <****> bbeattie: Create a much smaller test case please.
23:57 <****> ChibaPet: just use =cut
23:58 <****> ChibaPet: =item my_method ... =cut sub my_method { ...
23:58 <****> buu: R U EMPLOYED YET
23:58 <****> Oddly, my ... let's see... Twenty seven years of programming, now, suggests that I know what I want. The notion of having free nicely formatted documentation for free if I format it in my source seems nice. Literate programming made accessible. But I guess I'll just use =cut a bunch, if that's the answer. :P Thanks, Caelum. :)
23:58 <****> INITSELF MAYBE.
23:59 <****> ChibaPet: how does =cut not get you what you just described?
23:59 <****> Just because your tool lets you do something doesn't mean you should.
23:59 <****> Can I =item and =cut within the same =head? The =cut doesn't end the =head? That's my practical question, I guess.
--- Log closed Fri Nov 09 00:00:04 2007
Total 27 pages. You are browsing page 27/27.
First :: Prev :: [...] [23] [24] [25] [26] [27] :: Next :: Last