From fd25491807f1a2d8314dca14dfb01f224d6df093 Mon Sep 17 00:00:00 2001 From: The8472 Date: Sat, 23 Oct 2021 13:01:07 +0200 Subject: [PATCH] Add caveat about changing parallelism and function call overhead --- library/std/src/thread/mod.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/library/std/src/thread/mod.rs b/library/std/src/thread/mod.rs index b2aa500a0fd8f..1a5cf5ab8226a 100644 --- a/library/std/src/thread/mod.rs +++ b/library/std/src/thread/mod.rs @@ -1449,6 +1449,10 @@ fn _assert_sync_and_send() { /// global state in order to more accurately query the amount of available /// parallelism. /// +/// Resource limits can be changed during the runtime of a program, therefore the value is +/// not cached and instead recomputed every time this function is called. It should not be +/// called from hot code. +/// /// The value returned by this function should be considered a simplified /// approximation of the actual amount of parallelism available at any given /// time. To get a more detailed or precise overview of the amount of