updating comments

beer-garden · Oct 30, 2024 · 22d6552 · 22d6552
1 parent a37cbb3
commit 22d6552
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/brewtils/decorators.py b/brewtils/decorators.py
@@ -449,7 +449,10 @@ def cmd1(self, **kwargs):
 
 
 def shutdown(_wrapped=None):
-    """Decorator for specifying a function to run before a plugin is shutdown
+    """Decorator for specifying a function to run before a plugin is shutdown.
+
+    Functions called should short actions. Locally hosted plugin threads will be
+    pruned if not stopped within the plugin.timeout.shutdown time window
 
     for example::