Re: PDD for code comments ????

2001-03-27 Thread Dave Mitchell
Dan Sugalski [EMAIL PROTECTED] wrote: At 02:58 PM 3/26/2001 +0100, Dave Mitchell wrote: Nick Ing-Simmons [EMAIL PROTECTED] opined: Perhaps we could teach pod that /* was alias for =pod and */ an alias for =cut ? or possibly /*=foo is an alias for =foo, and */ is an alias for =cut

Re: PDD for code comments ????

2001-03-27 Thread Dan Sugalski
At 10:30 AM 3/27/2001 +0100, Dave Mitchell wrote: Dan Sugalski [EMAIL PROTECTED] wrote: At 02:58 PM 3/26/2001 +0100, Dave Mitchell wrote: Nick Ing-Simmons [EMAIL PROTECTED] opined: Perhaps we could teach pod that /* was alias for =pod and */ an alias for =cut ? or possibly

Re: PDD for code comments ????

2001-03-27 Thread Dan Sugalski
At 06:09 PM 3/27/2001 +0100, Dave Mitchell wrote: Dan Sugalski [EMAIL PROTECTED] wrote: I'm happy think that we're using a special extractor rather than pod - cf embed.pl producing perlapi.pod. However, I'd rather a plain ^/*...^*/ not be picked up. Same here. All the C comments ought

Re: PDD for code comments ????

2001-03-26 Thread Nick Ing-Simmons
David L . Nicol [EMAIL PROTECTED] writes: Jarkko Hietaniemi wrote: Some sort of simple markup embedded within the C comments. Hey, let's extend pod! Hey, let's use XML! Hey, let's use SGML! Hey, let's use XHTML! Hey, let's use lout! Hey, ... Either run pod through a pod puller before

Re: PDD for code comments ????

2001-03-26 Thread Dave Mitchell
Nick Ing-Simmons [EMAIL PROTECTED] opined: Either run pod through a pod puller before the C preprocessor gets to the code, or figure out a set of macros that can quote and ignore pod. The second is Yet Another Halting Problem so we go with the first? Which means a little program to depod

Re: PDD for code comments ????

2001-03-26 Thread Dan Sugalski
At 02:58 PM 3/26/2001 +0100, Dave Mitchell wrote: Nick Ing-Simmons [EMAIL PROTECTED] opined: Perhaps we could teach pod that /* was alias for =pod and */ an alias for =cut ? or possibly /*=foo is an alias for =foo, and */ is an alias for =cut only after a /*= has been encountered. I think

Re: PDD for code comments ????

2001-03-26 Thread nick
David L . Nicol [EMAIL PROTECTED] writes: Nick Ing-Simmons wrote: Perhaps we could teach pod that /* was alias for =pod and */ an alias for =cut ? that won't work because pod/cut is strictly line-based and C-style comments are strictly stream-based. I was not suggesting we hunt down 2 ** /*

Re: PDD for code comments ????

2001-02-21 Thread David Mitchell
Based on the silence == assent prinicple, I think we have agreed: 1. we need "a relatively strict and standard way" to document code. 2. This is the time and place to discuss it. 3. The result of the discusssion should be a PDD. 4. Most commentary should appear within the src file itself, or

Re: PDD for code comments ????

2001-02-20 Thread David Mitchell
Regarding comments in code: Chopping and misquoting wildly Jarkko Hietaniemi said: * I would define a relatively strict and standard way to do this so that the documentation can be extracted out. * lets avoid a markup-up flamewar Simon Cozens said: * I'd like to see Perl 6 written as a

Re: PDD for code comments ????

2001-02-20 Thread Nicholas Clark
On Tue, Feb 20, 2001 at 03:49:44PM +, David Mitchell wrote: 4. Are we all agreed that in addition to anything else (eg rfc281), at least some of the standard commentary should appear actually within the src file itself? quote from someone recently "separate documentation is no

Tolkein (was Re: PDD for code comments ????)

2001-02-20 Thread David Mitchell
Tolkien quotes are mandatory? perl5's globals.c malloc.c perlio.c perly.c universal.c xsutils.c definitely fail then. Sounds like some urgent patches need submitting to p5p ;-)

Re: Tolkein (was Re: PDD for code comments ????)

2001-02-20 Thread Roman M. Parparov
On Tue, Feb 20, 2001 at 05:57:10PM +, David Mitchell wrote: Do we want to go with Tolkein quotes for perl 6 and, if so, who wants to put together a list of good ones? It's been ages since I've read the books, and I'm likely to pull quotes from other places anyway. (Usagi Yojimbo

Re: Tolkein (was Re: PDD for code comments ????)

2001-02-20 Thread David Mitchell
Do we want to go with Tolkein quotes for perl 6 and, if so, who wants to put together a list of good ones? It's been ages since I've read the books, and I'm likely to pull quotes from other places anyway. (Usagi Yojimbo strikes me as a good place to yank from, as does Zot!, but Pratchett

Re: Tolkein (was Re: PDD for code comments ????)

2001-02-20 Thread David Mitchell
And what about us poor semi-literates who've never heard of Yojimbo ??? If we can't go with Tolkien, I'd vote for Pratchett, 'cause *everyone*'s read him :-) Adams rather than Pratchett, I'd think. :) But Pratchet has 20+ books to his credit, so we need never run out of quotes :-)

Re: Tolkein (was Re: PDD for code comments ????)

2001-02-20 Thread Nicholas Clark
On Tue, Feb 20, 2001 at 06:06:49PM +, David Mitchell wrote: And what about us poor semi-literates who've never heard of Yojimbo ??? If we can't go with Tolkien, I'd vote for Pratchett, 'cause *everyone*'s read him :-) Adams rather than Pratchett, I'd think. :) But Pratchet

Re: Tolkein (was Re: PDD for code comments ????)

2001-02-20 Thread Dan Sugalski
At 05:57 PM 2/20/2001 +, David Mitchell wrote: Do we want to go with Tolkein quotes for perl 6 and, if so, who wants to put together a list of good ones? It's been ages since I've read the books, and I'm likely to pull quotes from other places anyway. (Usagi Yojimbo strikes me as a

Re: Tolkein (was Re: PDD for code comments ????)

2001-02-20 Thread Simon Cozens
On Tue, Feb 20, 2001 at 07:43:11PM +0100, H.Merijn Brand wrote: My name (Merijn) is *from* Tolkien's dutch translation, so I'm a little biases if I state: "Stick with Tolkien". Well, I'm of to Mordor now ... http://www.prembone.com/mythtakes/shiresong.html --

Re: PDD for code comments ????

2001-02-20 Thread David L. Nicol
David Mitchell wrote: 4. Are we all agreed that in addition to anything else (eg rfc281), at least some of the standard commentary should appear actually within the src file itself? s/at least some/most, if not all/ 5. Do *all* these comments need to be extractable, or only ones related

Re: Tolkein (was Re: PDD for code comments ????)

2001-02-20 Thread Simply Hao
Douglas Adams does seem rather more appropriate a source of quotes for software (anyone's, alas) than Pratchett. But Adams already has a software company. -Hao

Re: Tolkein (was Re: PDD for code comments ????)

2001-02-20 Thread David L. Nicol
Simply Hao wrote: Douglas Adams does seem rather more appropriate a source of quotes for software (anyone's, alas) than Pratchett. But Adams already has a software company. And Sirius pioneered the GPP in Perl 6.

PDD for code comments ????

2001-02-19 Thread David Mitchell
I originally starting writing this as a bit of a joke, then I thought perhaps I should submit it as a serious suggestion. Anyone violently against or in favour? Is this even an issue that should go in a PDD? Does anyone care? Should I return to my box now? Dave M.

Re: PDD for code comments ????

2001-02-19 Thread Jarkko Hietaniemi
Not a joke, I find this to be a very valuable rule. No comments, no check-ins. I would define a relatively strict and standard way to do this so that the documentation can be extracted out. References: see perlapi and perlintern in the current development releases. A related matter is that

Re: PDD for code comments ????

2001-02-19 Thread Jarkko Hietaniemi
On Mon, Feb 19, 2001 at 02:27:06PM +, Simon Cozens wrote: On Mon, Feb 19, 2001 at 08:17:17AM -0600, Jarkko Hietaniemi wrote: I would define a relatively strict and standard way to do this so that the documentation can be extracted out. I'd like to see Perl 6 written as a literate

Re: PDD for code comments ????

2001-02-19 Thread Simon Cozens
On Mon, Feb 19, 2001 at 08:37:48AM -0600, Jarkko Hietaniemi wrote: Hey, let's extend pod! Hey, let's use XML! Hey, let's use SGML! Hey, let's use XHTML! Hey, let's use lout! Hey, ... Can we take this to perl6-trivial-flamewars-markup-language, please? :) -- "He was a modest,

Re: PDD for code comments ????

2001-02-19 Thread Jarkko Hietaniemi
On Mon, Feb 19, 2001 at 03:13:02PM +, Simon Cozens wrote: On Mon, Feb 19, 2001 at 08:37:48AM -0600, Jarkko Hietaniemi wrote: Hey, let's extend pod! Hey, let's use XML! Hey, let's use SGML! Hey, let's use XHTML! Hey, let's use lout! Hey, ... Can we take this to

Re: PDD for code comments ????

2001-02-19 Thread David L. Nicol
Jarkko Hietaniemi wrote: Some sort of simple markup embedded within the C comments. Hey, let's extend pod! Hey, let's use XML! Hey, let's use SGML! Hey, let's use XHTML! Hey, let's use lout! Hey, ... Either run pod through a pod puller before the C preprocessor gets to the code, or