Add remark about eventual consistency to Status struct

bikeshedder · bikeshedder · commit 2a584a99fa6d · 2024-05-09T09:49:30.000Z
diff --git a/src/lib.rs b/src/lib.rs
@@ -32,6 +32,14 @@ pub mod unmanaged;
 pub use deadpool_runtime::{Runtime, SpawnBlockingError};
 
 /// The current pool status.
+///
+/// **The status returned by the pool is not guaranteed to be consistent!**
+///
+/// While this features provides [eventual consistency][1] the numbers will be
+/// off when accessing the status of a pool under heavy load. These numbers
+/// are meant for an overall insight.
+///
+/// [1]: (https://en.wikipedia.org/wiki/Eventual_consistency)
 #[derive(Clone, Copy, Debug)]
 pub struct Status {
     /// The maximum size of the pool.
