Skip to content

Commit 297a5a1

Browse files
committed
testutils.tcl: correct and enhance comments explaining the import and auto-initialization mechanism
1 parent 8981481 commit 297a5a1

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

tests/testutils.tcl

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -198,10 +198,12 @@ namespace eval tk {
198198
# variables from a specific test domain (functional area). It hides
199199
# details/peculiarities from the test writer.
200200
#
201-
# The "import" subcmd invokes any proc "init" defined in the doamin-
202-
# specific namespace. See also the explanation of this mehanism below
203-
# the header for the section "DEFINITIONS OF UTILITY PROCS PER
204-
# FUNCTIONAL AREA" in this file.
201+
# The "import" subcmd invokes any proc "init" defined in the domain-
202+
# specific namespace. See also the explanation of this mehanism in
203+
# this file at:
204+
#
205+
# INIT PROCS, IMPORTING UTILITY PROCS AND ASSOCIATED NAMESPACE VARIABLES,
206+
# AND AUTO-INITIALIZATION
205207
#
206208
# Arguments:
207209
# subCmd : "import" or "forget"
@@ -314,6 +316,7 @@ namespace import -force tk::test::*
314316
# that foregoes the importing of the namespace variables and their automatic
315317
# re-initialization.
316318
#
319+
317320
namespace eval ::tk::test::button {
318321
proc bogusTrace args {
319322
error "trace aborted"
@@ -501,10 +504,10 @@ namespace eval ::tk::test::dialog {
501504

502505
# init --
503506
#
504-
# This is a reserved proc that is part of the auto-initialization mechanism
505-
# that proc testutils employs when importing utility procs with associated
506-
# namespace variables into the namespace in which a test file is executed.
507-
# See also the explanation at:
507+
# This is a reserved proc that is part of the mechanism that proc testutils
508+
# employs when importing utility procs and associated namespace variables
509+
# into the namespace in which a test file is executed.
510+
# See also the explanation in this file at:
508511
#
509512
# INIT PROCS, IMPORTING UTILITY PROCS AND ASSOCIATED NAMESPACE VARIABLES,
510513
# AND AUTO-INITIALIZATION
@@ -905,10 +908,10 @@ namespace eval ::tk::test::text {
905908

906909
# init --
907910
#
908-
# This is a reserved proc that is part of the auto-initialization mechanism
909-
# that proc testutils employs when importing utility procs with associated
910-
# namespace variables into the namespace in which a test file is executed.
911-
# See also the explanation at:
911+
# This is a reserved proc that is part of the mechanism that proc testutils
912+
# employs when importing utility procs and associated namespace variables
913+
# into the namespace in which a test file is executed.
914+
# See also the explanation in this file at:
912915
#
913916
# INIT PROCS, IMPORTING UTILITY PROCS AND ASSOCIATED NAMESPACE VARIABLES,
914917
# AND AUTO-INITIALIZATION

0 commit comments

Comments
 (0)