[Python-checkins] CVS: python/dist/src/Doc/doc doc.tex,1.38.2.1,1.38.2.2

[Fred L. Drake]

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

Modified Files:
      Tag: release21-maint
	doc.tex 
Log Message:

Add description of the "explanation" optional parameter added to the
\versionadded macro.

I originally thought this should not be merged into the 2.1 maintenance
branch, but reconsidered:  documentation changes may actually *use* the
new version of the markup, so the lack of this markup variant can
reasonably be considered a bug.


Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.38.2.1
retrieving revision 1.38.2.2
diff -C2 -r1.38.2.1 -r1.38.2.2
*** doc.tex	2001/04/18 05:14:32	1.38.2.1
--- doc.tex	2001/04/18 17:32:45	1.38.2.2
***************
*** 841,850 ****
      \end{macrodesc}
  
!     \begin{macrodesc}{versionadded}{\p{version}}
        The version of Python which added the described feature to the
!       library or C API.  This is typically added to the end of the
!       first paragraph of the description before any availability
!       notes.  The location should be selected so the explanation makes
!       sense and may vary as needed.
      \end{macrodesc}
  
--- 841,853 ----
      \end{macrodesc}
  
!     \begin{macrodesc}{versionadded}{\op{explanation}\p{version}}
        The version of Python which added the described feature to the
!       library or C API.  \var{explanation} should be a \emph{brief}
!       explanation of the change consisting of a capitalized sentence
!       fragment; a period will be appended by the formatting process.
!       This is typically added to the end of the first paragraph of the
!       description before any availability notes.  The location should
!       be selected so the explanation makes sense and may vary as
!       needed.
      \end{macrodesc}