Merge pull request #756 from Gr3at/docstring/issue-461

Add missing proxy property to docstring
eclipse-paho · Jan 3, 2024 · 3f71356 · 3f71356
2 parents b56032b + 2f76892
commit 3f71356
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/paho/mqtt/client.py b/src/paho/mqtt/client.py
@@ -848,6 +848,8 @@ def proxy_set(self, **proxy_args):
         proxy_addr: IP address or DNS name of proxy server
 
         (Optional)
+        proxy_port: (int) port number of the proxy server. If not provided,
+            the PySocks package default value will be utilized, which differs by proxy_type.
         proxy_rdns: boolean indicating whether proxy lookup should be performed
             remotely (True, default) or locally (False)
         proxy_username: username for SOCKS5 proxy, or userid for SOCKS4 proxy