Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk): narrow the Python OpenWAError docstring to what it covers

Yudhi Armyndharis53c3223f44ab
diff --git a/sdk/python/openwa/errors.py b/sdk/python/openwa/errors.py
index e35490016..4e12da3f7 100644
--- a/sdk/python/openwa/errors.py
+++ b/sdk/python/openwa/errors.py
@@ -17,7 +17,11 @@ from typing import Any, Mapping
class OpenWAError(Exception):
- """Base class for every error raised by the SDK."""
+ """Base class for errors the SDK raises for an API response or a timeout.
+
+ Connection failures surface as ``httpx.TransportError``; an invalid argument (a missing
+ ``base_url`` or ``api_key``, an empty or dot path segment) raises ``ValueError``.
+ """
class OpenWAApiError(OpenWAError):