summaryrefslogtreecommitdiffstats
path: root/doc/callback.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2018-06-30 13:44:25 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2018-06-30 13:44:25 (GMT)
commitbffb982059c34bbd6c4bcb6074af928f28ceeed4 (patch)
tree64892bd4ddd17f864c983cd63da2f3678780cb2a /doc/callback.n
parent0978bd50ce03a7d56c569156c606be4533699a31 (diff)
downloadtcl-bffb982059c34bbd6c4bcb6074af928f28ceeed4.zip
tcl-bffb982059c34bbd6c4bcb6074af928f28ceeed4.tar.gz
tcl-bffb982059c34bbd6c4bcb6074af928f28ceeed4.tar.bz2
More docs
Diffstat (limited to 'doc/callback.n')
-rw-r--r--doc/callback.n18
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/callback.n b/doc/callback.n
index 8244f07..a05eb9c 100644
--- a/doc/callback.n
+++ b/doc/callback.n
@@ -19,14 +19,16 @@ package require TclOO
.fi
.BE
.SH DESCRIPTION
-The \fBcallback\fR command, also called \fBmymethod\fR for compatibility with
-the ooutil package of Tcllib, and which should only be used from within the
-context of a call to a method (i.e. inside a method, constructor or destructor
-body) is used to generate a script fragment that will invoke the method,
-\fImethodName\fR, on the current object (as reported by \fBself\fR) when
-executed. Any additional arguments provided will be provided as leading
-arguments to the callback. The resulting script fragment shall be a proper
-list.
+The \fBcallback\fR command,
+'\" Based on notes in the tcllib docs, we know the provenance of mymethod
+also called \fBmymethod\fR for compatibility with the ooutil and snit packages
+of Tcllib,
+and which should only be used from within the context of a call to a method
+(i.e. inside a method, constructor or destructor body) is used to generate a
+script fragment that will invoke the method, \fImethodName\fR, on the current
+object (as reported by \fBself\fR) when executed. Any additional arguments
+provided will be provided as leading arguments to the callback. The resulting
+script fragment shall be a proper list.
.PP
Note that it is up to the caller to ensure that the current object is able to
handle the call of \fImethodName\fR; this command does not check that.