From 15b3d8abb0f782922e8b84734914599927745e97 Mon Sep 17 00:00:00 2001
From: Steve Lau <stevelauc@outlook.com>
Date: Sat, 7 Dec 2024 15:02:45 +0800
Subject: [PATCH] docs: give this config a more detailed explanation

---
 config.example.toml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/config.example.toml b/config.example.toml
index f2689dde..e2bb6e3c 100644
--- a/config.example.toml
+++ b/config.example.toml
@@ -103,7 +103,10 @@
 # enable_pipupgrade = true                         ###disabled by default
 # pipupgrade_arguments = "-y -u --pip-path pip"    ###disabled by default
 
-# Run `poetry self update` even if poetry was not installed with the official script
+# For the poetry step, by default, Topgrade skips its update if poetry is not 
+# installed with the official script. This configuration entry forces Topgrade 
+# to run the update in this case.
+#
 # (default: false)
 # poetry_force_self_update = true