Skip to content

Commit 9e95cec

Browse files
committed
Add documentation regarding plot settings
1 parent 8b01378 commit 9e95cec

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,19 @@ the total memory of the program as well as each child individually. If using
202202
the API directly, note that the return from ``memory_usage`` will include the
203203
child memory in a nested list along with the main process memory.
204204

205+
Plot settings
206+
===============================
207+
208+
By default, the command line call is set as the graph title. If you wish to customize it, you can use the ``-t`` option to manually set the figure title.
209+
210+
211+
mprof plot -t 'Recorded memory usage'
212+
213+
You can also hide the function timestamps using the ``n`` flag, such as
214+
215+
mprof plot -n
216+
217+
205218
Setting debugger breakpoints
206219
=============================
207220
It is possible to set breakpoints depending on the amount of memory used.

0 commit comments

Comments
 (0)