Add docstring for tls cert and key

locustio · Apr 27, 2020 · eb19c57 · eb19c57
1 parent 1594575
commit eb19c57
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/locust/env.py b/locust/env.py
@@ -124,6 +124,10 @@ def create_web_ui(self, host="", port=8089, auth_credentials=None, tls_cert=None
                      which means all interfaces
         :param port: Port that the web server should listen to
         :param auth_credentials: If provided (in format "username:password") basic auth will be enabled
+        :param tls_cert: An optional path (str) to a TLS cert. If this is provided the web UI will be
+                         served over HTTPS
+        :param tls_key: An optional path (str) to a TLS private key. If this is provided the web UI will be
+                        served over HTTPS
         """
         self.web_ui = WebUI(self, host, port, auth_credentials=auth_credentials, tls_cert=tls_cert, tls_key=tls_key)
         return self.web_ui