Improve action descriptions for Telegram bot (home-assistant#158022)

Author: hanwg

homeassistant/components/telegram_bot/__init__.py

@@ -524,6 +524,9 @@ async def async_send_telegram_message(service: ServiceCall) -> ServiceResponse:
             async_send_telegram_message,
             schema=schema,
             supports_response=supports_response,
+            description_placeholders={
+                "formatting_options_url": "https://core.telegram.org/bots/api#formatting-options"
+            },
         )
 
     return True

homeassistant/components/telegram_bot/strings.json

@@ -400,7 +400,7 @@
           "name": "[%key:component::telegram_bot::services::send_photo::fields::authentication::name%]"
         },
         "caption": {
-          "description": "The title of the media.",
+          "description": "[%key:component::telegram_bot::services::send_photo::fields::caption::description%]",
           "name": "[%key:component::telegram_bot::services::send_photo::fields::caption::name%]"
         },
         "chat_id": {
@@ -499,7 +499,7 @@
           "name": "[%key:component::telegram_bot::services::send_photo::fields::authentication::name%]"
         },
         "caption": {
-          "description": "The title of the animation.",
+          "description": "[%key:component::telegram_bot::services::send_photo::fields::caption::description%]",
           "name": "[%key:component::telegram_bot::services::send_photo::fields::caption::name%]"
         },
         "config_entry_id": {
@@ -600,7 +600,7 @@
           "name": "[%key:component::telegram_bot::services::send_photo::fields::authentication::name%]"
         },
         "caption": {
-          "description": "The title of the document.",
+          "description": "[%key:component::telegram_bot::services::send_photo::fields::caption::description%]",
           "name": "[%key:component::telegram_bot::services::send_photo::fields::caption::name%]"
         },
         "config_entry_id": {
@@ -745,7 +745,7 @@
           "name": "Keyboard"
         },
         "message": {
-          "description": "Message body of the notification.",
+          "description": "Message body of the notification.\nCan't parse entities? Format your message according to the [formatting options]({formatting_options_url}).",
           "name": "Message"
         },
         "message_tag": {
@@ -757,7 +757,7 @@
           "name": "Message thread ID"
         },
         "parse_mode": {
-          "description": "Parser for the message text.",
+          "description": "Parser for the message text.\nSee [formatting options]({formatting_options_url}) for more details.",
           "name": "Parse mode"
         },
         "reply_to_message_id": {
@@ -787,7 +787,7 @@
           "name": "Authentication method"
         },
         "caption": {
-          "description": "The title of the image.",
+          "description": "The title of the media.\nCan't parse entities? Format your message according to the [formatting options]({formatting_options_url}).",
           "name": "Caption"
         },
         "config_entry_id": {
@@ -991,7 +991,7 @@
           "name": "[%key:component::telegram_bot::services::send_photo::fields::authentication::name%]"
         },
         "caption": {
-          "description": "The title of the video.",
+          "description": "[%key:component::telegram_bot::services::send_photo::fields::caption::description%]",
           "name": "[%key:component::telegram_bot::services::send_photo::fields::caption::name%]"
         },
         "config_entry_id": {
@@ -1070,7 +1070,7 @@
           "name": "[%key:component::telegram_bot::services::send_photo::fields::authentication::name%]"
         },
         "caption": {
-          "description": "The title of the voice message.",
+          "description": "[%key:component::telegram_bot::services::send_photo::fields::caption::description%]",
           "name": "[%key:component::telegram_bot::services::send_photo::fields::caption::name%]"
         },
         "config_entry_id": {