[Python-checkins] CVS: python/dist/src/Doc/lib libcmd.tex,1.11,1.12
Fred L. Drake
fdrake@users.sourceforge.net
Wed, 26 Dec 2001 21:10:20 -0800
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv30943/lib
Modified Files:
libcmd.tex
Log Message:
Elaborate the descriptions for onecmd(), precmd(), and postcmd() so they are
useful.
Index: libcmd.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcmd.tex,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** libcmd.tex 2001/07/29 03:41:23 1.11
--- libcmd.tex 2001/12/27 05:10:18 1.12
***************
*** 23,27 ****
and \module{readline} is available, command completion is done
automatically.
-
\end{classdesc}
--- 23,26 ----
***************
*** 73,78 ****
\begin{methoddesc}{onecmd}{str}
! Interpret the argument as though it had been typed in in
! response to the prompt.
\end{methoddesc}
--- 72,80 ----
\begin{methoddesc}{onecmd}{str}
! Interpret the argument as though it had been typed in response to the
! prompt. This may be overridden, but should not normally need to be;
! see the \method{precmd()} and \method{postcmd()} methods for useful
! execution hooks. The return value is a flag indicating whether
! interpretation of commands by the interpreter should stop.
\end{methoddesc}
***************
*** 95,109 ****
\end{methoddesc}
! \begin{methoddesc}{precmd}{}
! Hook method executed just before the command line is interpreted, but
! after the input prompt is generated and issued. This
method is a stub in \class{Cmd}; it exists to be overridden by
! subclasses.
\end{methoddesc}
! \begin{methoddesc}{postcmd}{}
Hook method executed just after a command dispatch is finished. This
method is a stub in \class{Cmd}; it exists to be overridden by
! subclasses.
\end{methoddesc}
--- 97,120 ----
\end{methoddesc}
! \begin{methoddesc}{precmd}{line}
! Hook method executed just before the command line \var{line} is
! interpreted, but after the input prompt is generated and issued. This
method is a stub in \class{Cmd}; it exists to be overridden by
! subclasses. The return value is used as the command which will be
! executed by the \method{onecmd()} method; the \method{precmd()}
! implementation may re-write the command or simply return \var{line}
! unchanged.
\end{methoddesc}
! \begin{methoddesc}{postcmd}{stop, line}
Hook method executed just after a command dispatch is finished. This
method is a stub in \class{Cmd}; it exists to be overridden by
! subclasses. \var{line} is the command line which was executed, and
! \var{stop} is a flag which indicates whether execution will be
! terminated after the call to \method{postcmd()}; this will be the
! return value of the \method{onecmd()} method. The return value of
! this method will be used as the new value for the internal flag which
! corresponds to \var{stop}; returning false will cause interpretation
! to continue.
\end{methoddesc}