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

[Andreas K. <and...@ac...>]

> 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 test
> suite.
>
> It seems to me that either these two modules should not be released
> 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
> is provided, it needs to actually test something. A *.test file that
> 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