diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2024-01-25 20:26:52 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2024-01-25 20:26:52 (GMT) |
| commit | f8d6a0caa7bae8039d97eee6e30486fb424c438c (patch) | |
| tree | 18aa908e148f4d27f46f2e7e2cbb535923d12382 | |
| parent | d78ebb8e014475bdb1c47d4b695856f79925e755 (diff) | |
| download | tcl-f8d6a0caa7bae8039d97eee6e30486fb424c438c.zip tcl-f8d6a0caa7bae8039d97eee6e30486fb424c438c.tar.gz tcl-f8d6a0caa7bae8039d97eee6e30486fb424c438c.tar.bz2 | |
Tidy up a bit by adding some comments to findDocWords
| -rw-r--r-- | tools/findDocWords.tcl | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/tools/findDocWords.tcl b/tools/findDocWords.tcl index 2b585d5..0b25315 100644 --- a/tools/findDocWords.tcl +++ b/tools/findDocWords.tcl @@ -1,3 +1,17 @@ +# findDocWords.tcl -- +# +# This script attempts to find all non-dictionary words in the Tcl or Tk +# documentation tree. It handles the fairly common compoundWord trick our +# docs use, and isn't confused by nroff formatting directives, so it isn't +# just a standard spell check. +# +# Arguments: +# 1: Directory to look for man source files in. +# 2: Path to a plain text dictionary. Try /usr/share/dict/words on Linux. +# +# Copyright © 2024 Donal K Fellows. +# See "license.terms" for the license. + lassign $argv dir dictionary set f [open $dictionary] |