Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 7f10cce

Browse files
committed
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. ;-(
1 parent 3a2c462 commit 7f10cce

1 file changed

Lines changed: 12 additions & 13 deletions

File tree

Doc/lib/libdifflib.tex

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -146,21 +146,19 @@ \section{\module{difflib} ---
146146
\end{funcdesc}
147147

148148

149-
\begin{funcdesc}{IS_LINE_JUNK}{line}:
150-
151-
Return 1 for ignorable line: iff \var{line} is blank or contains a
152-
single \character{\#}. Used as a default for parameter
149+
\begin{funcdesc}{IS_LINE_JUNK}{line}
150+
Return true for ignorable lines. The line \var{line} is ignorable
151+
if \var{line} is blank or contains a single \character{\#},
152+
otherwise it is not ignorable. Used as a default for parameter
153153
\var{linejunk} in \function{ndiff()}.
154-
155154
\end{funcdesc}
156155

157156

158-
\begin{funcdesc}{IS_CHARACTER_JUNK}{ch}:
159-
160-
Return 1 for ignorable character: iff \var{ch} is a space or tab.
161-
Used as a default for parameter \var{charjunk} in
157+
\begin{funcdesc}{IS_CHARACTER_JUNK}{ch}
158+
Return true for ignorable characters. The character \var{ch} is
159+
ignorable if \var{ch} is a space or tab, otherwise it is not
160+
ignorable. Used as a default for parameter \var{charjunk} in
162161
\function{ndiff()}.
163-
164162
\end{funcdesc}
165163

166164

@@ -182,8 +180,9 @@ \subsection{SequenceMatcher Objects \label{sequence-matcher}}
182180
Optional argument \var{isjunk} must be \code{None} (the default) or
183181
a one-argument function that takes a sequence element and returns
184182
true if and only if the element is ``junk'' and should be ignored.
185-
\code{None} is equivalent to passing \code{lambda x: 0}, i.e.\ no
186-
elements are ignored. For example, pass
183+
Passing \code{None} for \var{b} is equivalent to passing
184+
\code{lambda x: 0}; in other words, no elements are ignored. For
185+
example, pass:
187186

188187
\begin{verbatim}
189188
lambda x: x in " \t"
@@ -445,7 +444,7 @@ \subsection{Differ Objects \label{differ-objects}}
445444
for filter functions (or \code{None}):
446445

447446
\var{linejunk}: A function that should accept a single string
448-
argument, and return true iff the string is junk. The default is
447+
argument, and return true if the string is junk. The default is
449448
module-level function \function{IS_LINE_JUNK()}, which filters out
450449
lines without visible characters, except for at most one pound
451450
character (\character{\#}).

0 commit comments

Comments
 (0)