Sorry, it wasn't clear to the perl-qa folks that I'm talking about
Perl5, not Perl6.
On Sun, Apr 22, 2001 at 10:43:12PM +0000, David Grove wrote:
> I do, however, think that it would be a good absolute to have a
> requirement of standard internal documentation, not just for the
> core, but to CPAN as well.
No nonononono. Please don't drag CPAN into this particular
conversation. I'm just trying to nail down p5p on this simple issue.
> "Reasonable amount", however, is arbitrary. Please qualify it.
Realize that there currently are nearly no controls. perhack
"suggests" a few things but they are not always followed.
Trying to lay down a documentation standard for the perl core, given
both its wide range of module types as well as its wide range of
personalities... that'll take a while. I'm just trying to avoid
things like XSLoader slipping in.
As I mentioned eariler, its probably better to prove by counter
example. For instance, B::Disassembler's docs are not enough, nor
B::Asmdata. You have to do better than that to get in. ByteLoader is
another.
> > 2) It has a reasonable amount of tests. Minimum must be more than
> > simply a compile test.
>
> I'm sure there will be items where testing would be superfluous
> or misleading.
What module doesn't need tests? Reference the eariler exchange
between myself and Jarko over this. At the very least you can always
test if it compiles and if it exports the right interface (ie. exports
the documented functions and/or the documented public methods exist).
Even 'less' can be tested to make sure its a no-op.
> > What is "reasonable" in each case is ultimately left up to the
> Pumpking.
>
> Always qualify your suggestions in group posts, please. The P5P may be
> used to working as an oligarchical monarchy, but the P6 groups have a
> happy democracy with only an occasional trump from above. Having abstained
> from the P5P for so long, it's been a long time since I've seen a
> suggestion with no content.
Sorry for not clarifying, this is purely a Perl5 thing.
--
Michael G. Schwern <[EMAIL PROTECTED]> http://www.pobox.com/~schwern/
Perl6 Quality Assurance <[EMAIL PROTECTED]> Kwalitee Is Job One
BOFH excuse #151:
Some one needed the powerstrip, so they pulled the switch plug.
