[Python-checkins] python/dist/src/Doc/lib libtextwrap.tex,1.3,1.4
fdrake@users.sourceforge.net
fdrake@users.sourceforge.net
Tue, 02 Jul 2002 22:08:50 -0700
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv31856
Modified Files:
libtextwrap.tex
Log Message:
Fix up a few more consistency nits and incorrectly applied markup.
Further clarify the English-centricity of fix_sentence_endings.
Index: libtextwrap.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libtextwrap.tex,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** libtextwrap.tex 2 Jul 2002 21:48:12 -0000 1.3
--- libtextwrap.tex 3 Jul 2002 05:08:48 -0000 1.4
***************
*** 65,72 ****
\begin{memberdesc}{width}
! (default: 70) The maximum length of wrapped lines. As long as there are
! no individual words in the input text longer than \var{width},
! \class{TextWrapper} guarantees that no output line will be longer than
! \var{width} characters.
\end{memberdesc}
--- 65,72 ----
\begin{memberdesc}{width}
! (default: \code{70}) The maximum length of wrapped lines. As long as
! there are no individual words in the input text longer than
! \member{width}, \class{TextWrapper} guarantees that no output line
! will be longer than \member{width} characters.
\end{memberdesc}
***************
*** 78,86 ****
\begin{memberdesc}{replace_whitespace}
! (default: \code{True}) If true, each whitespace character (as defined by
! \var{string.whitespace}) remaining after tab expansion will be replaced
! by a single space. \note{If \var{expand_tabs} is false and
! \var{replace_whitespace} is true, each tab character will be replaced by
! a single space, which is \emph{not} the same as tab expansion.}
\end{memberdesc}
--- 78,87 ----
\begin{memberdesc}{replace_whitespace}
! (default: \code{True}) If true, each whitespace character (as defined
! by \code{string.whitespace}) remaining after tab expansion will be
! replaced by a single space. \note{If \member{expand_tabs} is false
! and \member{replace_whitespace} is true, each tab character will be
! replaced by a single space, which is \emph{not} the same as tab
! expansion.}
\end{memberdesc}
***************
*** 107,129 ****
with this is algorithm is that it is unable to detect the difference
between ``Dr.'' in
\begin{verbatim}
[...] Dr. Frankenstein's monster [...]
\end{verbatim}
and ``Spot.'' in
\begin{verbatim}
[...] See Spot. See Spot run [...]
\end{verbatim}
! Furthermore, since it relies on \var{string.lowercase} for the
! definition of ``lowercase letter'', it is specific to English-language
! texts. Thus, \var{fix_sentence_endings} is false by default.
\end{memberdesc}
\begin{memberdesc}{break_long_words}
(default: \code{True}) If true, then words longer than
! \var{width} will be broken in order to ensure that no lines are longer
! than \var{width}. If it is false, long words will not be broken, and
! some lines may be longer than
! \var{width}. (Long words will be put on a line by themselves, in order
! to minimize the amount by which \var{width} is exceeded.)
\end{memberdesc}
--- 108,137 ----
with this is algorithm is that it is unable to detect the difference
between ``Dr.'' in
+
\begin{verbatim}
[...] Dr. Frankenstein's monster [...]
\end{verbatim}
+
and ``Spot.'' in
+
\begin{verbatim}
[...] See Spot. See Spot run [...]
\end{verbatim}
!
! \member{fix_sentence_endings} is false by default.
!
! Since the sentence detection algorithm relies on
! \code{string.lowercase} for the definition of ``lowercase letter,''
! and a convention of using two spaces after a period to separate
! sentences on the same line, it is specific to English-language texts.
\end{memberdesc}
\begin{memberdesc}{break_long_words}
(default: \code{True}) If true, then words longer than
! \member{width} will be broken in order to ensure that no lines are
! longer than \member{width}. If it is false, long words will not be
! broken, and some lines may be longer than \member{width}. (Long words
! will be put on a line by themselves, in order to minimize the amount
! by which \member{width} is exceeded.)
\end{memberdesc}
***************
*** 132,139 ****
\begin{methoddesc}{wrap}{text}
! Wraps the single paragraph in \var{text} (a string) so every line is at
! most \var{width} characters long. All wrapping options are taken from
! instance attributes of the \class{TextWrapper} instance. Returns a list
! of output lines, without final newlines.
\end{methoddesc}
--- 140,147 ----
\begin{methoddesc}{wrap}{text}
! Wraps the single paragraph in \var{text} (a string) so every line is
! at most \member{width} characters long. All wrapping options are
! taken from instance attributes of the \class{TextWrapper} instance.
! Returns a list of output lines, without final newlines.
\end{methoddesc}