docs(typing): tweak misc stuff for consistency

falconry · Nov 4, 2024 · 5672979 · 5672979
1 parent 6fbf085
commit 5672979
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/api/typing.rst b/docs/api/typing.rst
@@ -1,5 +1,5 @@
-Typing Support
-==============
+Typing
+======
 
 Type checking support was introduced in version 4.0. While most of the library is
 now typed, further type annotations may be added throughout the 4.x release cycle.
@@ -28,7 +28,7 @@ runtime behavior, but may surface new or different errors with type checkers.
     missing from the public interface!
 
 
-Known limitations
+Known Limitations
 -----------------
 
 Falcon's emphasis on flexibility and performance presents certain
@@ -68,7 +68,7 @@ checking:
     checking -- the above ``app`` will run just fine!
 
 
-Public type aliases
+Public Type Aliases
 -------------------
 
 .. automodule:: falcon.typing

diff --git a/falcon/typing.py b/falcon/typing.py
@@ -26,7 +26,7 @@
 
 # WSGI
 class ReadableIO(Protocol):
-    """File like protocol that defines only a read method."""
+    """File-like protocol that defines only a read method."""
 
     def read(self, n: Optional[int] = ..., /) -> bytes: ...