Docs, renaming websocket -> websockets

Kludex · Jul 16, 2021 · 3c7e44c · 3c7e44c
1 parent c680fb3
commit 3c7e44c
Show file tree

Hide file tree

Showing 5 changed files with 3 additions and 2 deletions.
diff --git a/docs/websockets.md b/docs/websockets.md
@@ -274,7 +274,7 @@ The `WebSocketCycle` is used by the adapter to communicate message events betwee
 
 ### WebSocketCycle
 
-::: mangum.protocols.websocket.WebSocketCycle
+::: mangum.protocols.websockets.WebSocketCycle
     :docstring:
     :members: run receive send 
 

diff --git a/mangum/protocols/__init__.py b/mangum/protocols/__init__.py
@@ -1,5 +1,5 @@
 from .http import HTTPCycle
-from .websocket import WebSocketCycle
+from .websockets import WebSocketCycle
 from .lifespan import LifespanCycleState, LifespanCycle
 
 __all__ = [

diff --git a/mangum/protocols/websocket.py → mangum/protocols/websockets.py b/mangum/protocols/websocket.py → mangum/protocols/websockets.py
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -16,6 +16,7 @@ nav:
     - Introduction: 'index.md'
     - Adapter: 'adapter.md'
     - HTTP: 'http.md'
+    - WebSockets: 'websockets.md'
     - Lifespan: 'lifespan.md'
     - ASGI Frameworks: 'asgi-frameworks.md'
     - External Links: 'external-links.md'

diff --git a/tests/test_websocket.py → tests/test_websockets.py b/tests/test_websocket.py → tests/test_websockets.py