Skip to content

Commit

Permalink
Document trace_python_allocators in the memray API docs
Browse files Browse the repository at this point in the history
We allow users to pass this value but we currently do not include it in
our public API documentation.

Signed-off-by: Pablo Galindo <pablogsal@gmail.com>
  • Loading branch information
pablogsal committed Jan 19, 2023
1 parent 42cdc47 commit 134b9e1
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/python_allocators.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Python allocators:

Python allocators
=================

Expand Down
3 changes: 3 additions & 0 deletions src/memray/_memray.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 134b9e1

Please sign in to comment.