From 44185dcfb94e224bd663b401a1a0d007b7a2aed0 Mon Sep 17 00:00:00 2001 From: JustaSqu1d Date: Mon, 12 Aug 2024 16:04:10 -0700 Subject: [PATCH] fix(sphinx): `autosectionlabel_prefix_document` to false --- discord/client.py | 4 ++-- docs/api/enums.rst | 4 ++-- docs/conf.py | 1 + 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/discord/client.py b/discord/client.py index 7f13696f6f..5f59ae3b08 100644 --- a/discord/client.py +++ b/discord/client.py @@ -1230,7 +1230,7 @@ def add_listener(self, func: Coro, name: str = MISSING) -> None: TypeError The ``func`` parameter is not a coroutine function. ValueError - The ``name`` (event name) does not start with 'on_' + The ``name`` (event name) does not start with ``on_`` Example ------- @@ -1294,7 +1294,7 @@ def listen(self, name: str = MISSING, once: bool = False) -> Callable[[Coro], Co TypeError The function being listened to is not a coroutine. ValueError - The ``name`` (event name) does not start with 'on_' + The ``name`` (event name) does not start with ``on_`` Example ------- diff --git a/docs/api/enums.rst b/docs/api/enums.rst index bd319f86eb..d454bae0a4 100644 --- a/docs/api/enums.rst +++ b/docs/api/enums.rst @@ -907,7 +907,7 @@ of :class:`enum.Enum`. When this is the action, the type of :attr:`~AuditLogEntry.extra` is either a :class:`Role` or :class:`Member`. If the object is not found then it is a :class:`Object` with an ID being filled, a name, and a - ``type`` attribute set to either ``'role'`` or ``'member'`` to help + ``type`` attribute set to either ``role`` or ``member`` to help dictate what type of ID it is. Possible attributes for :class:`AuditLogDiff`: @@ -2362,7 +2362,7 @@ of :class:`enum.Enum`. .. attribute:: advanced - Both default channels and questions (``OnboardingPrompt``s) will count towards the Onboarding requirements. + Both default channels and questions (``OnboardingPrompt``) will count towards the Onboarding requirements. .. class:: ReactionType diff --git a/docs/conf.py b/docs/conf.py index 2e8daf71ee..88a0960903 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -92,6 +92,7 @@ def write_new(): always_document_param_types = True toc_object_entries_show_parents = "hide" +autosectionlabel_prefix_document = True ogp_site_url = "https://pycord.dev/" ogp_image = "https://pycord.dev/static/img/logo.png"