mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-02 19:12:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 14

Enforce a bit of markup consistency.

Browse source 
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.  ;-(
This commit is contained in:
Fred Drake 2001-10-26 03:04:23 +00:00
parent 3a2c462436
commit 7f10cce4c1
1 changed files with 12 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Doc/lib/libdifflib.tex
View file

@ -146,21 +146,19 @@ emu
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{IS_LINE_JUNK}{line}: \begin{funcdesc}{IS_LINE_JUNK}{line}
Return true for ignorable lines. The line \var{line} is ignorable
Return 1 for ignorable line: iff \var{line} is blank or contains a if \var{line} is blank or contains a single \character{\#},
single \character{\#}. Used as a default for parameter otherwise it is not ignorable. Used as a default for parameter
\var{linejunk} in \function{ndiff()}. \var{linejunk} in \function{ndiff()}.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{IS_CHARACTER_JUNK}{ch}: \begin{funcdesc}{IS_CHARACTER_JUNK}{ch}
Return true for ignorable characters. The character \var{ch} is
Return 1 for ignorable character: iff \var{ch} is a space or tab. ignorable if \var{ch} is a space or tab, otherwise it is not
Used as a default for parameter \var{charjunk} in ignorable. Used as a default for parameter \var{charjunk} in
\function{ndiff()}. \function{ndiff()}.
\end{funcdesc} \end{funcdesc}
@ -182,8 +180,9 @@ The \class{SequenceMatcher} class has this constructor:
Optional argument \var{isjunk} must be \code{None} (the default) or Optional argument \var{isjunk} must be \code{None} (the default) or
a one-argument function that takes a sequence element and returns a one-argument function that takes a sequence element and returns
true if and only if the element is ``junk'' and should be ignored. 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 Passing \code{None} for \var{b} is equivalent to passing
elements are ignored. For example, pass \code{lambda x: 0}; in other words, no elements are ignored. For
example, pass:
\begin{verbatim} \begin{verbatim}
lambda x: x in " \t" lambda x: x in " \t"
@ -445,7 +444,7 @@ The \class{Differ} class has this constructor:
for filter functions (or \code{None}): for filter functions (or \code{None}):
\var{linejunk}: A function that should accept a single string \var{linejunk}: A function that should accept a single string
argument, and return true iff the string is junk. The default is argument, and return true if the string is junk. The default is
module-level function \function{IS_LINE_JUNK()}, which filters out module-level function \function{IS_LINE_JUNK()}, which filters out
lines without visible characters, except for at most one pound lines without visible characters, except for at most one pound
character (\character{\#}). character (\character{\#}).