Documenting SIGNALS_CUSTOM.

evennia/server/signals.py

@@ -93,6 +93,11 @@ SIGNAL_CHANNEL_POST_CREATE = Signal()
 SIGNAL_EXIT_TRAVERSED = Signal()
 
 # Used as a generic event emitter. Use to make your own signals easily in one place!
+# To use it, import SIGNALS_CUSTOM and use it like a dictionary of Signal objects.
+# Example:
+# from evennia.utils.signals import SIGNALS_CUSTOM
+# SIGNALS_CUSTOM['my_signal'].connect(my_callback)
+# SIGNALS_CUSTOM['my_signal'].send(sender, **kwargs)
 SIGNALS_CUSTOM: dict[str, Signal] = defaultdict(Signal)
 
 # Django default signals (https://docs.djangoproject.com/en/4.1/topics/signals/)