httpserver: update docstrings of url_for method

csernazs · csernazs · commit 79242e4f9d58 · 2022-09-25T23:51:57.000+02:00
This needs to be made a bit more exact, added note about IPv6 and TLS.
diff --git a/pytest_httpserver/httpserver.py b/pytest_httpserver/httpserver.py
@@ -654,6 +654,11 @@ def url_for(self, suffix: str):
         This basically means that it prepends the string ``http://$HOST:$PORT/`` to the `suffix` parameter
         (where $HOST and $PORT are the parameters given to the constructor).
 
+        When host is an IPv6 address, the required square brackets will be added
+        to it, forming a valid URL.
+
+        When SSL or TLS is in use, the protocol of the returned URL will be ``https``.
+
         :param suffix: the suffix which will be added to the base url. It can start with ``/`` (slash) or
             not, the url will be the same.
         :return: the full url which refers to the server
