Permalink
Browse files

Doc update

  • Loading branch information...
1 parent 4389d64 commit e07028e5266ab3c2a69796ffa5850c4759fae4c2 @fabianp committed Aug 4, 2012
Showing with 3 additions and 4 deletions.
  1. +1 −1 README.rst
  2. +2 −3 memory_profiler.py
View
@@ -87,7 +87,7 @@ file ~/.ipython/ipy_user_conf.py to add the following lines::
# These two are the important ones.
import memory_profiler
ip.expose_magic('mprun', memory_profiler.magic_mprun)
- ip.expose_magic('memit', memory_profiler.magic_memit)prun)
+ ip.expose_magic('memit', memory_profiler.magic_memit)
For IPython 0.11+, you have to edit the file
~/.ipython/extensions/memory_profiler_ext.py with the following content::
View
@@ -57,8 +57,7 @@ def memory_usage(proc=-1, num=-1, interval=.1):
interval : int, optional
num : int, optional
- Number of samples to generate. In the case of
- defaults to -1, meaning
+ Maximum number of retrievals. In the case of -1, meaning
to wait until the process has finished if proc is a string or
to get just one if proc is an integer.
@@ -67,7 +66,7 @@ def memory_usage(proc=-1, num=-1, interval=.1):
Returns
-------
- mm : list of integers
+ mm : list of integers, size less than num
memory usage, in KB
"""
ret = []

0 comments on commit e07028e

Please sign in to comment.