summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libprofile.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/lib/libprofile.tex')
-rw-r--r--Doc/lib/libprofile.tex9
1 files changed, 6 insertions, 3 deletions
diff --git a/Doc/lib/libprofile.tex b/Doc/lib/libprofile.tex
index 9ff5ba0..0108b21 100644
--- a/Doc/lib/libprofile.tex
+++ b/Doc/lib/libprofile.tex
@@ -384,14 +384,15 @@ arguments to supply the globals and locals dictionaries for the
\var{command} string.
\end{funcdesc}
-Analysis of the profiler data is done using this class from the
-\module{pstats} module:
+Analysis of the profiler data is done using the \class{Stats} class.
+
+\note{The \class{Stats} class is defined in the \module{pstats} module.}
% now switch modules....
% (This \stmodindex use may be hard to change ;-( )
\stmodindex{pstats}
-\begin{classdesc}{Stats}{filename\optional{, \moreargs\optional{, stream=sys.stdout}}}
+\begin{classdesc}{Stats}{filename\optional{, stream=sys.stdout\optional{, \moreargs}}}
This class constructor creates an instance of a ``statistics object''
from a \var{filename} (or set of filenames). \class{Stats} objects are
manipulated by methods, in order to print useful reports. You may specify
@@ -409,6 +410,8 @@ functions will be coalesced, so that an overall view of several
processes can be considered in a single report. If additional files
need to be combined with data in an existing \class{Stats} object, the
\method{add()} method can be used.
+
+\versionchanged[The \var{stream} parameter was added]{2.5}
\end{classdesc}