Skip to content

Commit

Permalink
bpo-27902: Add compatibility note to Profile docs (GH-7295)
Browse files Browse the repository at this point in the history
(cherry picked from commit f7745e1)

Co-authored-by: Tobias Kunze <r@rixx.de>
  • Loading branch information
miss-islington and rixx committed Jun 4, 2018
1 parent a7de148 commit 889a1ef
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions Doc/library/profile.rst
Expand Up @@ -310,11 +310,12 @@ Analysis of the profiler data is done using the :class:`~pstats.Stats` class.
corresponding version of :mod:`profile` or :mod:`cProfile`. To be specific,
there is *no* file compatibility guaranteed with future versions of this
profiler, and there is no compatibility with files produced by other
profilers. If several files are provided, all the statistics for identical
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:`~pstats.Stats` object, the
:meth:`~pstats.Stats.add` method can be used.
profilers, or the same profiler run on a different operating system. If
several files are provided, all the statistics for identical 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:`~pstats.Stats` object, the :meth:`~pstats.Stats.add` method
can be used.

Instead of reading the profile data from a file, a :class:`cProfile.Profile`
or :class:`profile.Profile` object can be used as the profile data source.
Expand Down

0 comments on commit 889a1ef

Please sign in to comment.