pythonprofilers / memory_profiler

Monitor Memory usage of Python code
http://pypi.python.org/pypi/memory_profiler
Other
4.39k stars 380 forks source link

Inconsistent documentation of units #399

Open paloha opened 9 months ago

paloha commented 9 months ago

Today a typo took some of my time.

The unit specified here is "Mb":

https://github.com/pythonprofilers/memory_profiler/blob/a99a3c3b3c2eb01c90f6e14ddfcb85b3e97f9885/mprof.py#L216

While the unit specified here is "MiB": https://github.com/pythonprofilers/memory_profiler/blob/a99a3c3b3c2eb01c90f6e14ddfcb85b3e97f9885/memory_profiler.py#L327

These are obviously not the same units and I believe the typo is in the file mprof.py and the unit should be corrected to "MiB" in both places. It is a small typo, but a since this is a memory profiler, I think it can cause a lot of headache to somebody.