[Python-checkins] python/dist/src/Doc/lib libtextwrap.tex,1.1,1.2

Tue, 02 Jul 2002 13:37:14 -0700

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv12034

Modified Files:
	libtextwrap.tex 
Log Message:
Deal with & remove the XXX comments.
Change the markup to be more like the rest of the documentation.

Index: libtextwrap.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libtextwrap.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** libtextwrap.tex	29 Jun 2002 02:38:50 -0000	1.1
--- libtextwrap.tex	2 Jul 2002 20:37:12 -0000	1.2
***************
*** 16,20 ****
  \class{TextWrapper} for efficiency.

! \begin{funcdesc}{wrap}{text, width=70, **kwargs}
  Wraps the single paragraph in \var{text} (a string) so every line is at
  most \var{width} characters long.  Returns a list of output lines,
--- 16,20 ----
  \class{TextWrapper} for efficiency.

! \begin{funcdesc}{wrap}{text\optional{, width\optional{, \moreargs}}}
  Wraps the single paragraph in \var{text} (a string) so every line is at
  most \var{width} characters long.  Returns a list of output lines,
***************
*** 22,29 ****

  Optional keyword arguments correspond to the instance attributes of
! \class{TextWrapper}, documented below.
  \end{funcdesc}

! \begin{funcdesc}{fill}{text, width=70, **kwargs}
  Wraps the single paragraph in \var{text}, and returns a single string
  containing the wrapped paragraph.  \function{fill()} is shorthand for
--- 22,30 ----

  Optional keyword arguments correspond to the instance attributes of
! \class{TextWrapper}, documented below.  \var{width} defaults to
! \code{70}.
  \end{funcdesc}

! \begin{funcdesc}{fill}{text\optional{, width\optional{, \moreargs}}}
  Wraps the single paragraph in \var{text}, and returns a single string
  containing the wrapped paragraph.  \function{fill()} is shorthand for
***************
*** 42,55 ****
  \class{TextWrapper} object.

! % XXX how to typeset long argument lists? this just spills off
! % the edge of the page, with or without \\ delimiters
! \begin{classdesc}{TextWrapper}{width=70, \\
!                                initial_indent="", \\
!                                subsequent_indent="", \\
!                                expand_tabs=True, \\
!                                replace_whitespace=True, \\
!                                fix_sentence_endings=False, \\
!                                break_long_words=True}
! 
  Each keyword argument to the constructor corresponds to an instance
  attribute, so for example
--- 43,49 ----
  \class{TextWrapper} object.

! \begin{classdesc}{TextWrapper}{width, initial_indent, subsequent_indent,
!                                expand_tabs, replace_whitespace,
!                                fix_sentence_endings, break_long_words}
  Each keyword argument to the constructor corresponds to an instance
  attribute, so for example
***************
*** 65,72 ****
  You can re-use the same \class{TextWrapper} object many times, and you
  can change any of its options through direct assignment to instance
! attributes between uses.  The effects of the instance attributes are as
! follows:

! \begin{memberdesc}[bool]{expand_tabs}
  If true (the default), then all tab characters in \var{text} will be
  expanded to spaces using the \method{expand_tabs()} method of
--- 59,69 ----
  You can re-use the same \class{TextWrapper} object many times, and you
  can change any of its options through direct assignment to instance
! attributes between uses.
! \end{classdesc}

! 
! The effects of the instance attributes are as follows:
! 
! \begin{memberdesc}{expand_tabs}
  If true (the default), then all tab characters in \var{text} will be
  expanded to spaces using the \method{expand_tabs()} method of
***************
*** 74,78 ****
  \end{memberdesc}

! \begin{memberdesc}[bool]{replace_whitespace}
  If true (the default), each whitespace character (as defined by
  \var{string.whitespace}) remaining after tab expansion will be replaced
--- 71,75 ----
  \end{memberdesc}

! \begin{memberdesc}{replace_whitespace}
  If true (the default), each whitespace character (as defined by
  \var{string.whitespace}) remaining after tab expansion will be replaced
***************
*** 82,99 ****
  \end{memberdesc}

! % XXX how to typeset the empty string? this looks awful, and "" is worse.
! \begin{memberdesc}[string]{initial_indent}
! (default: '') String that will be prepended to the first line of wrapped
! output.  Counts towards the length of the first line.
  \end{memberdesc}

! \begin{memberdesc}[string]{subsequent_indent}
! (default: '') String that will be prepended to all lines of wrapped
! output except the first.  Counts towards the length of each line except
! the first.
  \end{memberdesc}

! \begin{memberdesc}[bool]{fix_sentence_endings}
! (default: false) If true, \class{TextWrapper} attempts to detect
  sentence endings and ensure that sentences are always separated by
  exactly two spaces.  This is generally desired for text in a monospaced
--- 79,95 ----
  \end{memberdesc}

! \begin{memberdesc}{initial_indent}
! (default: \code{''}) String that will be prepended to the first line
! of wrapped output.  Counts towards the length of the first line.
  \end{memberdesc}

! \begin{memberdesc}{subsequent_indent}
! (default: \code{''}) String that will be prepended to all lines of
! wrapped output except the first.  Counts towards the length of each
! line except the first.
  \end{memberdesc}

! \begin{memberdesc}{fix_sentence_endings}
! (default: \code{False}) If true, \class{TextWrapper} attempts to detect
  sentence endings and ensure that sentences are always separated by
  exactly two spaces.  This is generally desired for text in a monospaced
***************
*** 116,120 ****
  \end{memberdesc}

! \begin{memberdesc}[bool]{break_long_words}
  If true (the default), then words longer than \var{width} will be broken
  in order to ensure that no lines are longer than \var{width}.  If it is
--- 112,116 ----
  \end{memberdesc}

! \begin{memberdesc}{break_long_words}
  If true (the default), then words longer than \var{width} will be broken
  in order to ensure that no lines are longer than \var{width}.  If it is
***************
*** 138,141 ****
  containing the wrapped paragraph.
  \end{methoddesc}
- 
- \end{classdesc}
--- 134,135 ----