Skip to content

Commit 5ade9c3

Browse files
committed
docstring tweaks
1 parent 1508708 commit 5ade9c3

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

appdaemon/plugins/hass/hassapi.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1693,9 +1693,10 @@ def process_conversation(
16931693
"""Send a message to a conversation agent for processing with the
16941694
`conversation.process action <https://www.home-assistant.io/integrations/conversation/#action-conversationprocess>`_
16951695
1696-
This action is able to return
1696+
This action is able to return
16971697
`response data <https://www.home-assistant.io/docs/scripts/perform-actions/#use-templates-to-handle-response-data>`_.
1698-
The response is the same response as for the `/api/conversation/process API <https://developers.home-assistant.io/docs/intent_conversation_api#conversation-response>`_.
1698+
The response is the same as the one returned by the `/api/conversation/process` API; see
1699+
`<https://developers.home-assistant.io/docs/intent_conversation_api#conversation-response>`_ for details.
16991700
17001701
See the docs on the `conversation integration <https://www.home-assistant.io/integrations/conversation/>`__ for
17011702
more information.

appdaemon/plugins/hass/hassplugin.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -738,8 +738,8 @@ async def call_plugin_service(
738738
service (str): Name of the service to call
739739
target (str | dict | None, optional): Target of the service. Defaults to None. If the ``entity_id`` argument
740740
is not used, then the value of the ``target`` argument is used directly.
741-
entity_id (str | list[str] | None, optional): Entity ID to target with the service call. Seems to be a
742-
legacy way . Defaults to None.
741+
entity_id (str | list[str] | None, optional): Entity ID to target with the service call. This argument is
742+
maintained for legacy compatibility. Defaults to None.
743743
hass_timeout (str | int | float, optional): Sets the amount of time to wait for a response from Home
744744
Assistant. If no value is specified, the default timeout is 10s. The default value can be changed using
745745
the ``ws_timeout`` setting the in the Hass plugin configuration in ``appdaemon.yaml``. Even if no data

docs/HISTORY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- Add request context logging for failed HASS calls - contributed by [ekutner](https://github.com/ekutner)
99
- Reload modified apps on SIGUSR2 - contributed by [chatziko](https://github.com/chatziko)
1010
- Using urlib to create endpoints from URLs - contributed by [cebtenzzre](https://github.com/cebtenzzre)
11-
- Added {py:meth}`~appdaemon.plugins.hass.hassapi.Hass.process_conversation` and {py:meth}`~appdaemon.plugins.hass.hassapi.Hass.reload_conversation` to the [Hass API](./HASS_API_REFERENCE.rst#api-usage)
11+
- Added {py:meth}`~appdaemon.plugins.hass.hassapi.Hass.process_conversation` and {py:meth}`~appdaemon.plugins.hass.hassapi.Hass.reload_conversation` to the [Hass API](./HASS_API_REFERENCE.rst#api-usage).
1212

1313
**Fixes**
1414

0 commit comments

Comments
 (0)