summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Shaw <shawaj@gmail.com>2023-04-14 15:31:02 +0100
committerGitHub <noreply@github.com>2023-04-14 16:31:02 +0200
commit9322179812d3177719c7bab23301646bbf862974 (patch)
tree461e5f1c09904d165841011427442b3a931f07e7
parent6e2dc7728f612b91d692fac5ab92cdd4521811c9 (diff)
downloadpsutil-9322179812d3177719c7bab23301646bbf862974.tar.gz
docs: add percentage usage of virtual memory (#2223)
docs was missing a note about percentage memory usage Signed-off-by: Aaron Shaw <shawaj@gmail.com>
-rw-r--r--docs/index.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index c722ee21..dfca444d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -345,6 +345,7 @@ Memory
Other metrics:
+ - **percent**: the percentage usage calculated as ``(total - available) / total * 100``
- **used**: memory used, calculated differently depending on the platform and
designed for informational purposes only. **total - free** does not
necessarily match **used**.