Skip to content

Commit

Permalink
docs review
Browse files Browse the repository at this point in the history
  • Loading branch information
pjenvey committed Feb 14, 2024
1 parent 7bd34cd commit 7bd448d
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions tests/load/locustfiles/stored.py
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ def send_notification(self) -> None:

@task(weight=5)
def connect_and_subscribe(self) -> None:
"""Connect, Subscribe a user to an Autopush channel, then disconnect."""
"""Connect, subscribe a user to an Autopush channel, then disconnect."""
if not self.initialized:
logger.debug("Task 'connect_and_subscribe' skipped.")
return
Expand Down Expand Up @@ -203,7 +203,11 @@ def connect_and_read(self) -> None:
self.close()

def connect(self) -> None:
"""Initialize the WebSocket, sending a Hello command"""
"""Connect the WebSocket, send the initial 'hello' message, then disconnect.
This receives a new UAID from autoconnect which is used throughout the
rest of the test.
"""
if not self.host:
raise LocustError("'host' value is unavailable.")

Expand All @@ -212,7 +216,7 @@ def connect(self) -> None:
self.initialized = True

def connect_and_hello(self) -> None:
"""Connect the WebSocket and complete the initial Hello handshake"""
"""Connect, 'hello', then read any pending notifications"""
self.ws = websocket.WebSocket()
self.ws.connect(self.host)
self.send_hello(self.ws)
Expand Down

0 comments on commit 7bd448d

Please sign in to comment.