Re: [Tcllib-devel] Tcllib - Dev- and other Guides - Looking For Feedback

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

On Wed, 17 Apr 2019 06:41:08 +0000
Arjen Markus <Arj...@de...> wrote:

> Hi Andreas,
> 
> I have several small remarks on the Tcl Library Source Code page:
> - Typo: ramafications should be ramification

Fixed

> - In the section Trunk: "and this exactly" should be "and this is
> exactly"

Fixed

> - In the section "Generate documentation for al modules" you may add
> that the tool updates the documentation, not simply generates
> everything

I suspect that you are confusing the `doc` method here with `localdoc`.

The latter is used to update the embedded and installation
documentation. As such it generates all the docs multiple times (html,
nroff, md), and updates the directories `embedded` and `idoc`.

While the `doc` command as specified generates the all docs, it only
generates the specified format, and places it into a `doc` directory
which has nothing to do with the embedded nor installations
docs/directories.

> - In the section Notes on Writing A Testsuite: "throws an
> understandable error. Instead of" should be "throws an understandable
> error, instead of"

Fixed

> 
> As for testsuites, I was impressed by this article,
> https://www.researchgate.net/publication/298896236, that, admittedly,
> is geared to a particular numerical algorithm but shows that even
> simple-looking algorithms can lead to an incredible number of test
> cases.

Added the reference

Committed and pushed fixes.

-- 
Andreas Kupries
SUSE Software Canada ULC
EuroTcl 2019, Jun 29-30, Nuernberg/DE, http://eurotcl.eu/
Tcl'2019, Nov 4-8, Houston, TX, USA.
http://www.tcl.tk/community/tcl2019/