From 134b9e18a91edd80f758b5d9e9a2b5f60da831be Mon Sep 17 00:00:00 2001 From: Pablo Galindo Date: Thu, 19 Jan 2023 14:00:32 +0000 Subject: [PATCH] Document ``trace_python_allocators`` in the memray API docs We allow users to pass this value but we currently do not include it in our public API documentation. Signed-off-by: Pablo Galindo --- docs/python_allocators.rst | 2 ++ src/memray/_memray.pyx | 3 +++ 2 files changed, 5 insertions(+) diff --git a/docs/python_allocators.rst b/docs/python_allocators.rst index bf0739321b..3abcd1a09e 100644 --- a/docs/python_allocators.rst +++ b/docs/python_allocators.rst @@ -1,3 +1,5 @@ +.. _Python allocators: + Python allocators ================= diff --git a/src/memray/_memray.pyx b/src/memray/_memray.pyx index 875933ec28..67ca3bf700 100644 --- a/src/memray/_memray.pyx +++ b/src/memray/_memray.pyx @@ -334,6 +334,9 @@ cdef class Tracker: native_traces (bool): Whether or not to capture native stack frames, in addition to Python stack frames (see :ref:`Native Tracking`). Defaults to False. + trace_python_allocators (bool): Whether or not to trace Python allocators + as independent allocations. (see :ref:`Python allocators`). + Defaults to False. follow_fork (bool): Whether or not to continue tracking in a subprocess that is forked from the tracked process (see :ref:`Tracking across Forks`). Defaults to False.