From 52fe5517f716dedf9c9918e56325e49a49146130 Mon Sep 17 00:00:00 2001 From: Giampaolo Rodola Date: Sun, 9 Apr 2023 11:32:21 +0200 Subject: [PATCH] update cpu_freq() doc --- docs/index.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index dcc25ab04..119102a8d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -268,13 +268,13 @@ CPU .. function:: cpu_freq(percpu=False) Return CPU frequency as a named tuple including *current*, *min* and *max* - frequencies expressed in Mhz. - On Linux *current* frequency reports the real-time value, on all other - platforms this usually represents the nominal "fixed" value (never changing). - If *percpu* is ``True`` and the system supports per-cpu frequency - retrieval (Linux only) a list of frequencies is returned for each CPU, - if not, a list with a single element is returned. - If *min* and *max* cannot be determined they are set to ``0.0``. + frequencies expressed in Mhz. On Linux *current* frequency reports the + real-time value, on all other platforms this usually represents the + nominal "fixed" value (never changing). If *percpu* is ``True`` and the + system supports per-cpu frequency retrieval (Linux and FreeBSD), a list of + frequencies is returned for each CPU, if not, a list with a single element + is returned. If *min* and *max* cannot be determined they are set to + ``0.0``. Example (Linux): @@ -289,7 +289,8 @@ CPU scpufreq(current=1703.609, min=800.0, max=3500.0), scpufreq(current=1754.289, min=800.0, max=3500.0)] - Availability: Linux, macOS, Windows, FreeBSD, OpenBSD + Availability: Linux, macOS, Windows, FreeBSD, OpenBSD. *percpu* only + supported on Linux and FreeBSD. .. versionadded:: 5.1.0