diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2008-10-15 10:43:37 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2008-10-15 10:43:37 (GMT) |
| commit | 89b27a8118e809ac322a0200fbda93fd65b03d15 (patch) | |
| tree | 76a9fcf427bd66b39f4124071860e59744540d77 /doc/WrongNumArgs.3 | |
| parent | 9621a454a0bde1f84cef51026947815d4eb244b6 (diff) | |
| download | tcl-89b27a8118e809ac322a0200fbda93fd65b03d15.zip tcl-89b27a8118e809ac322a0200fbda93fd65b03d15.tar.gz tcl-89b27a8118e809ac322a0200fbda93fd65b03d15.tar.bz2 | |
Lots of very minor formatting fixes.
Diffstat (limited to 'doc/WrongNumArgs.3')
| -rw-r--r-- | doc/WrongNumArgs.3 | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/WrongNumArgs.3 b/doc/WrongNumArgs.3 index daa729c..323ad40 100644 --- a/doc/WrongNumArgs.3 +++ b/doc/WrongNumArgs.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: WrongNumArgs.3,v 1.12 2007/12/13 15:22:32 dgp Exp $ +'\" RCS: @(#) $Id: WrongNumArgs.3,v 1.13 2008/10/15 10:43:37 dkf Exp $ '\" .so man.macros .TH Tcl_WrongNumArgs 3 8.0 Tcl "Tcl Library Procedures" @@ -31,7 +31,6 @@ Additional error information to print after leading arguments from \fIobjv\fR. This typically gives the acceptable syntax of the command. This argument may be NULL. .BE - .SH DESCRIPTION .PP \fBTcl_WrongNumArgs\fR is a utility procedure that is invoked by @@ -45,13 +44,17 @@ elements of \fIobjv\fR plus \fImessage\fR. For example, if .QW "\fBfileName count\fR" then \fIinterp\fR's result object will be set to the following string: +.PP .CS wrong # args: should be "foo fileName count" .CE +.PP If \fIobjc\fR is 2, the result will be set to the following string: +.PP .CS wrong # args: should be "foo bar fileName count" .CE +.PP \fIObjc\fR is usually 1, but may be 2 or more for commands like \fBstring\fR and the Tk widget commands, which use the first argument as a subcommand. @@ -68,12 +71,11 @@ originally passed in. Using the above example, let us assume that \fIbar\fR is actually an abbreviation for \fIbarfly\fR and the object is now an indexObject because it was passed to \fBTcl_GetIndexFromObj\fR. In this case the error message would be: +.PP .CS wrong # args: should be "foo barfly fileName count" .CE - .SH "SEE ALSO" -Tcl_GetIndexFromObj - +Tcl_GetIndexFromObj(3) .SH KEYWORDS command, error message, wrong number of arguments |