Re: What should and shouldn't get documented?

2001-09-24 Thread Dan Sugalski
At 01:16 PM 9/24/2001 +0100, Dave Mitchell wrote: >Dan Sugalski <[EMAIL PROTECTED]> wrote: > > Subject: What should and shouldn't get documented? > > > > I see there's a lot of embedded documentation going into the core, and > > that's a good thing.

Re: What should and shouldn't get documented?

2001-09-24 Thread Dave Mitchell
I wrote: > Should we go the full hog and make the /*=for api ... */ bit in the > src field subsume any info we currently append to embed.pl etc in Perl 5? s/field/file/

Re: What should and shouldn't get documented?

2001-09-24 Thread Dave Mitchell
Dan Sugalski <[EMAIL PROTECTED]> wrote: > Subject: What should and shouldn't get documented? > > I see there's a lot of embedded documentation going into the core, and > that's a good thing. That brings up a question, though--what exactly should > we d

Re: What should and shouldn't get documented?

2001-09-23 Thread Michael G Schwern
On Sun, Sep 23, 2001 at 10:05:57PM -0400, Dan Sugalski wrote: > I see there's a lot of embedded documentation going into the core, and > that's a good thing. That brings up a question, though--what exactly should > we document, and where should it be seen? > > For an example, the opcode functio

What should and shouldn't get documented?

2001-09-23 Thread Dan Sugalski
I see there's a lot of embedded documentation going into the core, and that's a good thing. That brings up a question, though--what exactly should we document, and where should it be seen? For an example, the opcode functions should *never* be used outside the interpreter core itself, but docu