Update dependency mkdocstrings to v0.28.3 (#2200)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: davfsa <davfsa@gmail.com>

hikari/api/event_manager.py

@@ -93,7 +93,7 @@ def close(self) -> None:
         If called on an already closed streamer then this will do nothing.
 
         !!! note
-            [with streamer][] may be used as a short-cut for opening and
+            `with streamer` may be used as a short-cut for opening and
             closing a streamer.
         """
 
@@ -104,7 +104,7 @@ def open(self) -> None:
         If called on an already started streamer then this will do nothing.
 
         !!! note
-            [with streamer][] may be used as a short-cut for opening and
+            `with streamer` may be used as a short-cut for opening and
             closing a stream.
         """
 
@@ -424,8 +424,8 @@ def stream(
         """Return a stream iterator for the given event and sub-events.
 
         !!! warning
-            If you use [await stream.open()][] to start the stream then you must
-            also close it with [await stream.close()][] otherwise it may queue
+            If you use `await stream.open()` to start the stream then you must
+            also close it with `await stream.close()` otherwise it may queue
             events in memory indefinitely.
 
         Parameters

hikari/api/voice.py

@@ -168,7 +168,7 @@ async def initialize(
             The channel ID that the voice connection is actively connected to.
         endpoint
             The voice websocket endpoint to connect to. Will contain the
-            protocol at the start (i.e. [wss://][]), and end with the **correct**
+            protocol at the start (i.e. `wss://`), and end with the **correct**
             port (the port and protocol are sanitized since Discord still
             provide the wrong information four years later).
         guild_id

hikari/applications.py

@@ -263,7 +263,7 @@ class ConnectionVisibility(int, enums.Enum):
 class OwnConnection:
     """Represents a user's connection with a third party account.
 
-    Returned by the [GET Current User Connections][] endpoint.
+    Returned by the `GET Current User Connections` endpoint.
     """
 
     id: str = attrs.field(hash=True, repr=True)

hikari/colors.py

@@ -182,7 +182,7 @@ def rgb(self) -> tuple[int, int, int]:
 
         Examples
         --------
-        [(123, 234, 47)][]
+        `(123, 234, 47)`
         """
         return (self >> 16) & 0xFF, (self >> 8) & 0xFF, self & 0xFF
 
@@ -194,7 +194,7 @@ def rgb_float(self) -> tuple[float, float, float]:
 
         Examples
         --------
-        [(0.1, 0.2, 0.76)][]
+        `(0.1, 0.2, 0.76)`
         """
         r, g, b = self.rgb
         return r / 0xFF, g / 0xFF, b / 0xFF

hikari/permissions.py

@@ -154,7 +154,7 @@ class Permissions(enums.Flag):
     """Allows for sending messages in a channel."""
 
     SEND_TTS_MESSAGES = 1 << 12
-    """Allows for sending of [/tts][] messages."""
+    """Allows for sending of Text-To-Speech (`/tts`) messages."""
 
     MANAGE_MESSAGES = 1 << 13
     """Allows for deletion of other users messages.

pipelines/mkdocs.nox.py

@@ -42,7 +42,7 @@ def mkdocs(session: nox.Session):
     """Generate docs using mkdocs."""
     _setup_environ(session)
 
-    nox.sync(session, self=True, groups=["mkdocs"])
+    nox.sync(session, self=True, groups=["mkdocs", "ruff"])
 
     session.run("mkdocs", "build", "-d", config.DOCUMENTATION_OUTPUT_PATH)
 
@@ -52,7 +52,7 @@ def mkdocs_serve(session: nox.Session):
     """Start an HTTP server that serves the generated docs in real time."""
     _setup_environ(session)
 
-    nox.sync(session, self=True, groups=["mkdocs"])
+    nox.sync(session, self=True, groups=["mkdocs", "ruff"])
 
     if "--no-reload" in session.posargs:
         session.run("mkdocs", "serve", "--no-livereload")

pyproject.toml

@@ -110,7 +110,7 @@ mkdocs = [
     # Mkdocs Material
     "mkdocs-material[imaging]==9.6.7",
     # Docstring parsing for API reference
-    "mkdocstrings[python]==0.28.2",
+    "mkdocstrings[python]==0.28.3",
     "griffe-inherited-docstrings==1.1.1",
     # Generate API reference pages dynamically
     "mkdocs-gen-files==0.5.0",