From db11ba743708d9550357f3129b7be9356c09b4c2 Mon Sep 17 00:00:00 2001
From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com>
Date: Wed, 22 Oct 2025 14:59:30 +0200
Subject: [PATCH] add docstring

---
 client/ayon_core/lib/local_settings.py | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/client/ayon_core/lib/local_settings.py b/client/ayon_core/lib/local_settings.py
index 4402e3c8a1..8a17b7af38 100644
--- a/client/ayon_core/lib/local_settings.py
+++ b/client/ayon_core/lib/local_settings.py
@@ -584,7 +584,19 @@ def _get_ayon_service_username() -> Optional[str]:
 
 
 def get_ayon_user_entity(username: Optional[str] = None) -> dict[str, Any]:
-    """AYON user entity used for templates and publishing."""
+    """AYON user entity used for templates and publishing.
+
+    Note:
+        Usually only service and admin users can receive the full user entity.
+
+    Args:
+        username (Optional[str]): Username of the user. If not passed, then
+            the current user in 'ayon_api' is used.
+
+    Returns:
+        dict[str, Any]: User entity.
+
+    """
     service_username = _get_ayon_service_username()
     # Handle service user handling first
     if service_username: