Re: [Tcllib-devel] question about tcllib imap4 and page modules

[Virden, L. W. <lv...@ca...>]

=20
Re: imap4

Sorry about that - I thought I recalled reading some discussion
regarding the imap4 module that sounded as if it were released. I
apologize for misremembering.

Re: empty test cases

I don't know, for certain. I just thought it might be worthwhile to make
certain we state that , just in case someone "clever" decided to submit
their package with an empty test suite (or man page file, or a man page
file that basically said "no documentation is available at this time").

--=20
<URL: http://wiki.tcl.tk/ >
Even if explicitly stated to the contrary, nothing in this posting
should be construed as representing my employer's opinions.
<URL: mailto:lv...@gm... > <URL: http://www.purl.org/NET/lvirden/
>
=20

-----Original Message-----
From: Andreas Kupries [mailto:and...@ac...]=20
Sent: Thursday, August 30, 2007 12:04 PM
To: Virden, Larry W.; tcl...@li...
Subject: RE: [Tcllib-devel] question about tcllib imap4 and page modules

> the tcllib README file says
>
>
> * the module should have both documentation ([*]) and a test suite
>   (in the form of a group of *.test files in the module directory).
>
>   [*] Possible forms: doctools, TMML/XML, nroff (man), or HTML.
>       The first format is the most preferred as it can be processed
with
>       tools provided by tcllib itself (See module doctools). The first
>       two are preferred in general as they are semantic markup and
thus
>       easier to convert into other formats.
>
> * the module must have either documentation or a test suite.  It can
>   not have neither.
>
>
> However, the imap4 and page modules have neither documentation or a=20
> test suite.
>
> It seems to me that either these two modules should not be released=20
> with Tcllib or documentation should be added.

imap4 is not released ... It may be in the distribution archives, it
will not be installed however, as it is not listed in
support/installation/modules.tcl. It does not even have a pkgIndex.tcl
file.
Nobody seems to be willing to clean it up and make it working.

The page module however is installed, and my responsibility. I better
start working on the documentation for its packages then.


> I also would argue that the README should state that if a *.test file=20
> is provided, it needs to actually test something. A *.test file that=20
> is empty or performs no tests is the same as not having a test
suite...

True. Do we have packages/modules where that is the case ?

--
	Andreas Kupries <and...@Ac...>
	Developer @ http://www.ActiveState.com
	Tel: +1 778-786-1122