[New-bugs-announce] [issue20468] resource module documentation is incorrect

[Kurt Rose]

New submission from Kurt Rose:

The documentation in the resource module for get_page_size() is incorrect.

resource.getpagesize()
Returns the number of bytes in a system page. (This need not be the same as the hardware page size.) This function is useful for determining the number of bytes of memory a process is using. The third element of the tuple returned by getrusage() describes memory usage in pages; multiplying by page size produces number of bytes.

On Linux, the value returned in getrusage().ru_maxrss is in kilobytes.  On OS-X it is in bytes.  Ideally, this could be put into the documentation, but at least remove the inaccurate recommendation to multiply maxrss by page size :-)

----------
assignee: ronaldoussoren
components: Macintosh
messages: 209844
nosy: Kurt.Rose, ronaldoussoren
priority: normal
severity: normal
status: open
title: resource module documentation is incorrect
versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue20468>
_______________________________________