Skip to content

Commit 76a7c40

Browse files
authored
Update README.rst
Correct typos in the `include-children` flag (`-` not `_`)
1 parent 0d21b8d commit 76a7c40

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ track the usage of child processes: sum the memory of all children to the
179179
parent's usage and track each child individual.
180180

181181
To create a report that combines memory usage of all the children and the
182-
parent, use the ``include_children`` flag in either the ``profile`` decorator or
182+
parent, use the ``include-children`` flag in either the ``profile`` decorator or
183183
as a command line argument to ``mprof``::
184184

185185
mprof run --include-children <script>
@@ -197,7 +197,7 @@ This will create a plot using matplotlib similar to this:
197197
:target: https://github.com/pythonprofilers/memory_profiler/pull/134
198198
:height: 350px
199199

200-
You can combine both the ``include_children`` and ``multiprocess`` flags to show
200+
You can combine both the ``include-children`` and ``multiprocess`` flags to show
201201
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.

0 commit comments

Comments
 (0)