Minor corrections.

This commit is contained in:
Raymond Hettinger 2003-07-17 14:47:12 +00:00
parent e9a92aa03a
commit 943277ecd3
2 changed files with 8 additions and 2 deletions

View File

@ -193,12 +193,15 @@ module docstring, and all function, class and method docstrings are
searched. Optionally, the tester can be directed to exclude
docstrings attached to objects with private names.
Objects imported into the module are not searched.
\versionchanged[Previously, the tester defaulted to skipping objects
with private names (to obtain version independence, explicitly specify
\var{isprivate} when launching doctests)]{2.3}
In addition, if \code{M.__test__} exists and "is true", it must be a
dict, and each entry maps a (string) name to a function object, class
object, or string. Function and class object docstrings found from
\code{M.__test__} are searched even if the the tester has been
directly to skip over private names in the rest of the module.
directed to skip over private names in the rest of the module.
In output, a key \code{K} in \code{M.__test__} appears with name
\begin{verbatim}
@ -312,6 +315,9 @@ are run.
\end{verbatim}
\versionadded{2.3}
\warning{\function{DocTestSuite()} does not current search \code{M.__test__}
and its search technique does not exactly match \function{testmod()} in
every detail. Future versions will bring the two into convergence.}
\end{funcdesc}

View File

@ -1150,7 +1150,7 @@ a Boolean value, else a \exception{TypeError} will be raised.
By convention, \code{False} is used for false and \code{True} for true.
There are no implied relationships among the comparison operators.
The truth of {\var{x}==\var{y}} does not imply that \code{\var{x}!=\var{y}}
The truth of \code{\var{x}==\var{y}} does not imply that \code{\var{x}!=\var{y}}
is false. Accordingly, when defining \method{__eq__}, one should also
define \method{__ne__} so that the operators will behave as expected.