[Tcllib-devel] Re: [Starkit] filleting tcllib

Donald G Porter dgp at nist.gov
Wed May 4 11:11:17 CEST 2005


> For tcllib, i think the best way would be to either add such information 
> to the package documentation, ...

IMHO...

Every package, whether in the tcllib distribution or not, ought to
document its dependencies in the SYNOPSIS of its man page.

For example, the documentation for package smtp 1.4 ought to have
a SYNPOSIS like:

    package require Tcl 8.3
    package require mime 1.4
    package require smtp 1.4
    
    <document each command syntax...>
    
Except for the missing "8.3" requirement for Tcl, the smtp package
docs satisify this.  Are there packages in tcllib that do not?

| Don Porter          Mathematical and Computational Sciences Division |
| donald.porter at nist.gov             Information Technology Laboratory |
| http://math.nist.gov/~DPorter/                                  NIST |
|______________________________________________________________________|



More information about the Starkit mailing list