From a5f5182db2469b4185bb2845e4f04fba9a688062 Mon Sep 17 00:00:00 2001
From: lukinovec <lukinovec@gmail.com>
Date: Wed, 15 Apr 2026 08:58:32 +0200
Subject: [PATCH] Improve stopImpersonating docblock

---
 src/Features/UserImpersonation.php | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/Features/UserImpersonation.php b/src/Features/UserImpersonation.php
index 034c1915..be2b01fd 100644
--- a/src/Features/UserImpersonation.php
+++ b/src/Features/UserImpersonation.php
@@ -81,7 +81,13 @@ class UserImpersonation implements Feature
     }
 
     /**
-     * Logout from the current domain and forget impersonation session.
+     * Stop user impersonation by forgetting the impersonation session.
+     *
+     * When $logout is true, the user will also be logged out
+     * from the impersonation guard stored in the session.
+     *
+     * Throws an exception if impersonation is not active
+     * (= the impersonation guard is not in the session).
      */
     public static function stopImpersonating(bool $logout = true): void
     {