diff options
| author | Giampaolo Rodola <g.rodola@gmail.com> | 2019-04-12 00:47:03 +0200 |
|---|---|---|
| committer | Giampaolo Rodola <g.rodola@gmail.com> | 2019-04-12 00:47:03 +0200 |
| commit | 55f4b24642b53c747540a02b4161753d1ea7e1f9 (patch) | |
| tree | 2523f92d26e04d2b44f7c2eae7ba19f849d4eb60 /docs | |
| parent | 50defe14d1dabba3c048eaa5d8789239b0d7671f (diff) | |
| download | psutil-55f4b24642b53c747540a02b4161753d1ea7e1f9.tar.gz | |
update doc
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 19 |
1 files changed, 8 insertions, 11 deletions
diff --git a/docs/index.rst b/docs/index.rst index 1469e61b..95a5e2ce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -240,17 +240,14 @@ CPU .. function:: getloadavg() - Returns the average load on the system over the last 1, 5 and 15 minutes - respectively as a tuple. The load represents how many processes are waiting - to be run by the operating system. - - On UNIX systems this relies on `os.getloadavg`_. On Windows, this is - emulated by using a Windows API call that spawns a thread which updates the - average every 5 seconds mimicking the UNIX behavior. Thus, the first time - this is called and up until 5 seconds it returns a meaningless - ``(0.0, 0.0, 0.0)`` tuple. - - Example: + Return the average system load over the last 1, 5 and 15 minutes as a tuple. + The load represents how many processes are waiting to be run by the + operating system. + On UNIX systems this relies on `os.getloadavg`_. On Windows this is + emulated by using a Windows API that spawns a thread which updates the + average every 5 seconds, mimicking the UNIX behavior. Thus, the first time + this is called and for the next 5 seconds it will return a meaningless + ``(0.0, 0.0, 0.0)`` tuple. Example: .. code-block:: python |
