comments

custom_components/openai_whisper_cloud/config_flow.py

@@ -43,10 +43,7 @@
 
 
 async def validate_input(data: dict):
-    """Validate the user input allows us to connect.
-
-    Data has the keys from DATA_SCHEMA with values provided by the user.
-    """
+    """Validate the user input."""
 
     if data.get(CONF_TEMPERATURE) is None:
         data[CONF_TEMPERATURE] = DEFAULT_TEMPERATURE
@@ -78,7 +75,7 @@ async def validate_input(data: dict):
 
 
 class ConfigFlow(ConfigFlow, domain=DOMAIN):
-    """Handle a config flow for OpenAI Whisper Cloud."""
+    """Handle UI config flow."""
 
     VERSION = 1
     MINOR_VERSION = 0
@@ -88,7 +85,7 @@ async def async_step_user(
         user_input: dict[str, Any] | None = None,
         errors: dict[str, str] | None = None,
     ) -> ConfigFlowResult:
-        """Handle the initial step."""
+        """Handle initial step."""
         errors = {}
         if user_input is not None:
             try:
@@ -116,16 +113,16 @@ async def async_step_user(
 
 
 class UnknownError(exceptions.HomeAssistantError):
-    """Error to indicate we cannot connect."""
+    """Unknown error."""
 
 
 class UnauthorizedError(exceptions.HomeAssistantError):
-    """Error to indicate there is an invalid api_key."""
+    """API key valid but doesn't have the rights to use Whisper."""
 
 
 class InvalidAPIKey(exceptions.HomeAssistantError):
-    """Error to indicate there is an invalid api_key."""
+    """Invalid api_key error."""
 
 
 class WhisperModelBlocked(exceptions.HomeAssistantError):
-    """Error to indicate there is an invalid api_key."""
+    """Whisper not found in the available OpenAI models."""

custom_components/openai_whisper_cloud/manifest.json

@@ -7,8 +7,8 @@
   ],
   "config_flow": true,
   "dependencies": [],
-  "documentation": "https://github.com/fabio-garavini/openai_whisper_cloud",
-  "issue_tracker": "https://github.com/fabio-garavini/openai_whisper_cloud/issues",
+  "documentation": "https://github.com/fabio-garavini/ha-openai-whisper-stt-api",
+  "issue_tracker": "https://github.com/fabio-garavini/ha-openai-whisper-stt-api/issues",
   "homekit": {},
   "iot_class": "cloud_push",
   "requirements": [],

custom_components/openai_whisper_cloud/stt.py

@@ -1,4 +1,4 @@
-"""Support for OpenAI Whisper API speech-to-text service."""
+"""OpenAI Whisper API speech-to-text entity."""
 
 from __future__ import annotations