From 540dfe292730455993cb144f22f8375e27eacc6c Mon Sep 17 00:00:00 2001
From: syeopite <syeopite@syeopite.dev>
Date: Tue, 12 Nov 2024 09:19:43 -0800
Subject: [PATCH] Improve documentation of idle pool size

---
 config/config.example.yml | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/config/config.example.yml b/config/config.example.yml
index e3a264ca..a886eccb 100644
--- a/config/config.example.yml
+++ b/config/config.example.yml
@@ -158,6 +158,13 @@ https_only: false
 ## Max idle size of the HTTP pool used to connect to youtube. Each
 ## domain ('youtube.com', 'ytimg.com', ...) has its own pool.
 ##
+## This means that when releasing a connection back into the pool, it will
+## be closed if there are already more than idle_pool_size connections within
+## the pool
+##
+## Do note that idle connections are kept around forever without any way of
+## timing them out.
+##
 ## When unset this value has the same value as pool_size 
 ##
 ## Accepted values: a positive integer