Assorted fixes to the docs.

aaugustin · aaugustin · commit 4a2cfd5eaccb · 2025-02-09T20:30:33.000+01:00
diff --git a/docs/intro/index.rst b/docs/intro/index.rst
@@ -35,6 +35,7 @@ Tutorial
 Learn how to build an real-time web application with websockets.
 
 .. toctree::
+    :maxdepth: 1
 
     tutorial1
     tutorial2
diff --git a/docs/reference/asyncio/client.rst b/docs/reference/asyncio/client.rst
@@ -1,5 +1,5 @@
-Client (new :mod:`asyncio`)
-===========================
+Client (:mod:`asyncio`)
+=======================
 
 .. automodule:: websockets.asyncio.client
 
diff --git a/docs/reference/asyncio/common.rst b/docs/reference/asyncio/common.rst
@@ -1,7 +1,7 @@
 :orphan:
 
-Both sides (new :mod:`asyncio`)
-===============================
+Both sides (:mod:`asyncio`)
+===========================
 
 .. automodule:: websockets.asyncio.connection
 
diff --git a/docs/reference/asyncio/server.rst b/docs/reference/asyncio/server.rst
@@ -1,5 +1,5 @@
-Server (new :mod:`asyncio`)
-===========================
+Server (:mod:`asyncio`)
+=======================
 
 .. automodule:: websockets.asyncio.server
 
diff --git a/docs/reference/features.rst b/docs/reference/features.rst
@@ -68,6 +68,7 @@ Both sides
     | Measure latency                    | ✅     | ✅     | —      | ✅     |
     +------------------------------------+--------+--------+--------+--------+
     | Perform the closing handshake      | ✅     | ✅     | ✅     | ✅     |
+    +------------------------------------+--------+--------+--------+--------+
     | Enforce closing timeout            | ✅     | ✅     | —      | ✅     |
     +------------------------------------+--------+--------+--------+--------+
     | Report close codes and reasons     | ✅     | ✅     | ✅     | ❌     |
@@ -177,7 +178,7 @@ There is no way to control compression of outgoing frames on a per-frame basis
 .. _#538: https://github.com/python-websockets/websockets/issues/538
 
 The server doesn't check the Host header and doesn't respond with HTTP 400 Bad
-Request if it is missing or invalid (`#1246`).
+Request if it is missing or invalid (`#1246`_).
 
 .. _#1246: https://github.com/python-websockets/websockets/issues/1246
 
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -51,12 +51,11 @@ application servers.
    sansio/server
    sansio/client
 
-:mod:`asyncio` (legacy)
------------------------
-
-This is the historical implementation.
+Legacy
+------
 
-It is deprecated and will be removed.
+This is the historical implementation. It is deprecated. It will be removed by
+2030.
 
 .. toctree::
    :titlesonly:
@@ -67,7 +66,7 @@ It is deprecated and will be removed.
 Extensions
 ----------
 
-The Per-Message Deflate extension is built in. You may also define custom
+The Per-Message Deflate extension is built-in. You may also define custom
 extensions.
 
 .. toctree::
diff --git a/docs/reference/legacy/client.rst b/docs/reference/legacy/client.rst
@@ -1,5 +1,5 @@
-Client (legacy :mod:`asyncio`)
-==============================
+Client (legacy)
+===============
 
 .. admonition:: The legacy :mod:`asyncio` implementation is deprecated.
     :class: caution
diff --git a/docs/reference/legacy/common.rst b/docs/reference/legacy/common.rst
@@ -1,7 +1,7 @@
 :orphan:
 
-Both sides (legacy :mod:`asyncio`)
-==================================
+Both sides (legacy)
+===================
 
 .. admonition:: The legacy :mod:`asyncio` implementation is deprecated.
     :class: caution
diff --git a/docs/reference/legacy/server.rst b/docs/reference/legacy/server.rst
@@ -1,5 +1,5 @@
-Server (legacy :mod:`asyncio`)
-==============================
+Server (legacy)
+===============
 
 .. admonition:: The legacy :mod:`asyncio` implementation is deprecated.
     :class: caution
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -33,6 +33,7 @@ healthz
 html
 hypercorn
 iframe
+io
 IPv
 istio
 iterable
diff --git a/docs/topics/design.rst b/docs/topics/design.rst
@@ -1,7 +1,7 @@
 :orphan:
 
-Design (legacy :mod:`asyncio`)
-==============================
+Design (legacy)
+===============
 
 .. currentmodule:: websockets.legacy
 
