]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
SF bug #1215887: String and list methods documentation deeply hidden
authorRaymond Hettinger <python@rcn.com>
Tue, 14 Jun 2005 08:47:19 +0000 (08:47 +0000)
committerRaymond Hettinger <python@rcn.com>
Tue, 14 Jun 2005 08:47:19 +0000 (08:47 +0000)
Make doc on specific types easier to find by listing them in the headings
for the abstract types.

Doc/lib/libstdtypes.tex

index 113a9c420de0bfae727cc3fee654ced8898b1ff1..740887de2f74b942348e265037ff5f7d4ae1bbc3 100644 (file)
@@ -72,7 +72,9 @@ return one of their operands.)
 \index{False}
 \index{True}
 
-\subsection{Boolean Operations \label{boolean}}
+\subsection{Boolean Operations ---
+           \keyword{and}, \keyword{or}, \keyword{not}
+           \label{boolean}}
 
 These are the Boolean operations, ordered by ascending priority:
 \indexii{Boolean}{operations}
@@ -173,7 +175,9 @@ Two more operations with the same syntactic priority,
 only by sequence types (below).
 
 
-\subsection{Numeric Types \label{typesnumeric}}
+\subsection{Numeric Types ---
+           \class{int}, \class{float}, \class{long}, \class{complex}
+           \label{typesnumeric}}
 
 There are four distinct numeric types: \dfn{plain integers},
 \dfn{long integers}, 
@@ -256,7 +260,7 @@ comparison operations):
   \lineiii{float(\var{x})}{\var{x} converted to floating point}{}
   \lineiii{complex(\var{re},\var{im})}{a complex number with real part \var{re}, imaginary part \var{im}.  \var{im} defaults to zero.}{}
   \lineiii{\var{c}.conjugate()}{conjugate of the complex number \var{c}}{}
-  \lineiii{divmod(\var{x}, \var{y})}{the pair \code{(\var{x} / \var{y}, \var{x} \%{} \var{y})}}{(3)(4)}
+  \lineiii{divmod(\var{x}, \var{y})}{the pair \code{(\var{x} // \var{y}, \var{x} \%{} \var{y})}}{(3)(4)}
   \lineiii{pow(\var{x}, \var{y})}{\var{x} to the power \var{y}}{}
   \lineiii{\var{x} ** \var{y}}{\var{x} to the power \var{y}}{}
 \end{tableiii}
@@ -405,7 +409,10 @@ return an iterator object (technically, a generator object)
 supplying the \method{__iter__()} and \method{next()} methods.
 
 
-\subsection{Sequence Types \label{typesseq}}
+\subsection{Sequence Types ---
+           \class{str}, \class{unicode}, \class{list},
+           \class{tuple}, \class{buffer}, \class{xrange}
+           \label{typesseq}}
 
 There are six sequence types: strings, Unicode strings, lists,
 tuples, buffers, and xrange objects.
@@ -1157,7 +1164,9 @@ Notes:
   that the list has been mutated during a sort.
 \end{description}
 
-\subsection{Set Types \label{types-set}}
+\subsection{Set Types ---
+           \class{set}, \class{frozenset}
+           \label{types-set}}
 \obindex{set}
 
 A \dfn{set} object is an unordered collection of immutable values.
@@ -1283,7 +1292,7 @@ Note, the non-operator versions of the \method{update()},
 as an argument.
 
 
-\subsection{Mapping Types \label{typesmapping}}
+\subsection{Mapping Types --- class{dict} \label{typesmapping}}
 \obindex{mapping}
 \obindex{dictionary}