From 3c7e44c383413d1de56a092bde06b2167bfc7090 Mon Sep 17 00:00:00 2001 From: Jordan Eremieff Date: Sat, 17 Jul 2021 04:06:53 +1000 Subject: [PATCH] Docs, renaming websocket -> websockets --- docs/websockets.md | 2 +- mangum/protocols/__init__.py | 2 +- mangum/protocols/{websocket.py => websockets.py} | 0 mkdocs.yml | 1 + tests/{test_websocket.py => test_websockets.py} | 0 5 files changed, 3 insertions(+), 2 deletions(-) rename mangum/protocols/{websocket.py => websockets.py} (100%) rename tests/{test_websocket.py => test_websockets.py} (100%) diff --git a/docs/websockets.md b/docs/websockets.md index 3037525e..52fecd6b 100644 --- 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 index de20b15a..27df010c 100644 --- 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 b/mangum/protocols/websockets.py similarity index 100% rename from mangum/protocols/websocket.py rename to mangum/protocols/websockets.py diff --git a/mkdocs.yml b/mkdocs.yml index 097cbdc5..ae3e892d 100644 --- 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 b/tests/test_websockets.py similarity index 100% rename from tests/test_websocket.py rename to tests/test_websockets.py