[Python-checkins] CVS: python/dist/src/Doc/lib libdifflib.tex,1.9,1.10
Fred L. Drake
fdrake@users.sourceforge.net
Thu, 25 Oct 2001 20:04:25 -0700
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv26523/lib
Modified Files:
libdifflib.tex
Log Message:
Enforce a bit of markup consistency.
When describing a Boolean return value, use "true" and "false" instead of
"1" and "0".
Style-guide conformance: no "iff" -- to obscure for many readers. ;-(
Index: libdifflib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libdifflib.tex,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** libdifflib.tex 2001/09/22 21:30:22 1.9
--- libdifflib.tex 2001/10/26 03:04:23 1.10
***************
*** 147,165 ****
! \begin{funcdesc}{IS_LINE_JUNK}{line}:
!
! Return 1 for ignorable line: iff \var{line} is blank or contains a
! single \character{\#}. Used as a default for parameter
\var{linejunk} in \function{ndiff()}.
-
\end{funcdesc}
-
- \begin{funcdesc}{IS_CHARACTER_JUNK}{ch}:
! Return 1 for ignorable character: iff \var{ch} is a space or tab.
! Used as a default for parameter \var{charjunk} in
\function{ndiff()}.
-
\end{funcdesc}
--- 147,163 ----
! \begin{funcdesc}{IS_LINE_JUNK}{line}
! Return true for ignorable lines. The line \var{line} is ignorable
! if \var{line} is blank or contains a single \character{\#},
! otherwise it is not ignorable. Used as a default for parameter
\var{linejunk} in \function{ndiff()}.
\end{funcdesc}
! \begin{funcdesc}{IS_CHARACTER_JUNK}{ch}
! Return true for ignorable characters. The character \var{ch} is
! ignorable if \var{ch} is a space or tab, otherwise it is not
! ignorable. Used as a default for parameter \var{charjunk} in
\function{ndiff()}.
\end{funcdesc}
***************
*** 183,188 ****
a one-argument function that takes a sequence element and returns
true if and only if the element is ``junk'' and should be ignored.
! \code{None} is equivalent to passing \code{lambda x: 0}, i.e.\ no
! elements are ignored. For example, pass
\begin{verbatim}
--- 181,187 ----
a one-argument function that takes a sequence element and returns
true if and only if the element is ``junk'' and should be ignored.
! Passing \code{None} for \var{b} is equivalent to passing
! \code{lambda x: 0}; in other words, no elements are ignored. For
! example, pass:
\begin{verbatim}
***************
*** 446,450 ****
\var{linejunk}: A function that should accept a single string
! argument, and return true iff the string is junk. The default is
module-level function \function{IS_LINE_JUNK()}, which filters out
lines without visible characters, except for at most one pound
--- 445,449 ----
\var{linejunk}: A function that should accept a single string
! argument, and return true if the string is junk. The default is
module-level function \function{IS_LINE_JUNK()}, which filters out
lines without visible characters, except for at most one pound