"Add docstrings to all functions and file headers."
Description
This PR adds docstrings to functions and file headers in main.py and utils.py to provide clear and concise documentation for the code. The following changes were made:
Added a docstring to the file header of main.py to describe its purpose and functionality.
Added a docstring to the direct(client, message) function in main.py to provide a description of its purpose, arguments, and return value.
Added a docstring to the WebSocketRateLimiter.acquire(self, client_id) function in utils.py to describe its purpose, arguments, and return value.
Added a docstring to the isAuthenticated(server, client, authenticated_clients) function in utils.py to provide a description of its purpose, arguments, and return value.
Summary of Changes
Added docstring to file header of main.py
Added docstring to direct(client, message) function in main.py
Added docstring to WebSocketRateLimiter.acquire(self, client_id) function in utils.py
Added docstring to isAuthenticated(server, client, authenticated_clients) function in utils.py
PR Feedback: 👎
I created this PR to address this rule:
"Add docstrings to all functions and file headers."
Description
This PR adds docstrings to functions and file headers in
main.py
andutils.py
to provide clear and concise documentation for the code. The following changes were made:main.py
to describe its purpose and functionality.direct(client, message)
function inmain.py
to provide a description of its purpose, arguments, and return value.WebSocketRateLimiter.acquire(self, client_id)
function inutils.py
to describe its purpose, arguments, and return value.isAuthenticated(server, client, authenticated_clients)
function inutils.py
to provide a description of its purpose, arguments, and return value.Summary of Changes
main.py
direct(client, message)
function inmain.py
WebSocketRateLimiter.acquire(self, client_id)
function inutils.py
isAuthenticated(server, client, authenticated_clients)
function inutils.py