From 733e50ad9ee2885323c39080b42716fa5d1fd8c1 Mon Sep 17 00:00:00 2001
From: Victor Stinner <victor.stinner@gmail.com>
Date: Thu, 6 Mar 2014 17:06:41 +0100
Subject: [PATCH] tracemalloc.py: add comments to show the format of tuples

---
 Lib/tracemalloc.py | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Lib/tracemalloc.py b/Lib/tracemalloc.py
index dd73d053b40..f117127339a 100644
--- a/Lib/tracemalloc.py
+++ b/Lib/tracemalloc.py
@@ -141,6 +141,7 @@ class Frame:
     __slots__ = ("_frame",)
 
     def __init__(self, frame):
+        # frame is a tuple: (filename: str, lineno: int)
         self._frame = frame
 
     @property
@@ -177,6 +178,8 @@ class Traceback(Sequence):
 
     def __init__(self, frames):
         Sequence.__init__(self)
+        # frames is a tuple of frame tuples: see Frame constructor for the
+        # format of a frame tuple
         self._frames = frames
 
     def __len__(self):
@@ -241,6 +244,8 @@ class Trace:
     __slots__ = ("_trace",)
 
     def __init__(self, trace):
+        # trace is a tuple: (size, traceback), see Traceback constructor
+        # for the format of the traceback tuple
         self._trace = trace
 
     @property
@@ -268,6 +273,7 @@ class Trace:
 class _Traces(Sequence):
     def __init__(self, traces):
         Sequence.__init__(self)
+        # traces is a tuple of trace tuples: see Trace constructor
         self._traces = traces
 
     def __len__(self):
@@ -338,6 +344,8 @@ class Snapshot:
     """
 
     def __init__(self, traces, traceback_limit):
+        # traces is a tuple of trace tuples: see _Traces constructor for
+        # the exact format
         self.traces = _Traces(traces)
         self.traceback_limit = traceback_limit