[Python-checkins] bpo-27902: Add compatibility note to Profile docs (GH-7295)
Miss Islington (bot)
webhook-mailer at python.org
Mon Jun 4 13:25:40 EDT 2018
https://github.com/python/cpython/commit/7548a9327409df787eef5f8c2780b53b5788012f
commit: 7548a9327409df787eef5f8c2780b53b5788012f
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018-06-04T10:25:37-07:00
summary:
bpo-27902: Add compatibility note to Profile docs (GH-7295)
(cherry picked from commit f7745e1dcb8e8473cc86112a0213b3f244a07230)
Co-authored-by: Tobias Kunze <r at rixx.de>
files:
M Doc/library/profile.rst
diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst
index a6dc56f43cbc..3f3c8a948562 100644
--- a/Doc/library/profile.rst
+++ b/Doc/library/profile.rst
@@ -317,11 +317,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.
More information about the Python-checkins
mailing list