Skip to content

Commit b894c6e

Browse files
committed
Update README.rst
1 parent 909017d commit b894c6e

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@ To install from source, download the package, extract and type::
2525
Usage
2626
=======
2727

28-
The line-by-line profiler is used much in the same way of the
28+
29+
line-by-line memory usage
30+
=========================
31+
32+
The line-by-line memory usage mode is used much in the same way of the
2933
`line_profiler <https://pypi.python.org/pypi/line_profiler/>`_: first
3034
decorate the function you would like to profile with ``@profile`` and
3135
then run the script with a special script (in this case with specific
@@ -103,7 +107,7 @@ decorator function. Use as follows::
103107
If a python script with decorator ``@profile`` is called using ``-m
104108
memory_profiler`` in the command line, the ``precision`` parameter is ignored.
105109

106-
Executing external scripts
110+
Time-based memory usage
107111
==========================
108112
Sometimes it is useful to have full memory usage reports as a function of
109113
time (not line-by-line) of external processes (be it Python scripts or not).
@@ -129,7 +133,7 @@ of the code that is causing the highest memory usage.
129133
Adding the `profile` decorator to a function and running the Python
130134
script with
131135

132-
mprof run --python <script>
136+
mprof run <script>
133137

134138
will record timestamps when entering/leaving the profiled function. Runnning
135139

0 commit comments

Comments
 (0)