From 9a587918fb4eb44511ababd1e26b67ae83a78f86 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Mon, 26 Jun 2023 16:04:13 -0400 Subject: [PATCH] doc --- src/Tiny_httpd_pool.mli | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/Tiny_httpd_pool.mli b/src/Tiny_httpd_pool.mli index 117869ef..ab9aaa41 100644 --- a/src/Tiny_httpd_pool.mli +++ b/src/Tiny_httpd_pool.mli @@ -1,4 +1,11 @@ -(** Resource pool *) +(** Resource pool. + + This pool is used for buffers. It can be used for other resources + but do note that it assumes resources are still reasonably + cheap to produce and discard, and will never block waiting for + a resource — it's not a good pool for DB connections. + + @since NEXT_RELEASE. *) type 'a t (** Pool of values of type ['a] *)