Skip to content

Commit 788c5f5

Browse files
committed
Small safe_dispatch docs fix.
1 parent 0c4666c commit 788c5f5

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

twitchio/client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ def dispatch(self, event: str, payload: Any | None = None) -> None:
267267
waits.add(task)
268268

269269
def safe_dispatch(self, name: str, *, payload: Any | None = None) -> None:
270-
"""Method to dispatch a custom :ref:`_Event`.
270+
"""Method to dispatch a custom :ref:`event <Event Ref>`.
271271
272272
When an event is dispatched all listeners listening to the event, coroutine functions defined on the
273273
:class:`~twitchio.Client` with the same name, and :meth:`~twitchio.Client.wait_for` waiting for the event will be
@@ -277,7 +277,7 @@ def safe_dispatch(self, name: str, *, payload: Any | None = None) -> None:
277277
it is not documented and you should use this method instead when needing a custom event dispatched.
278278
279279
This method avoids conflicts with internal events by prefixing the name of the event with ``event_safe_``;
280-
specifically in this case ``_safe_`` is added between the ``event_`` prefix and the name of the event.
280+
specifically in this case ``safe_`` is added between the ``event_`` prefix and the name of the event.
281281
282282
All events in TwitchIO, including custom ones, must take between ``0`` or ``1`` arguments only. If ``None`` is
283283
passed to the payload parameter (default), the event will be dispatched with no arguments attached. Otherwise you can

0 commit comments

Comments
 (0)