Fix grammar in some hassio docstrings (#86458)

pull/86463/head
Erik Montnemery 2023-01-23 15:45:08 +01:00 committed by GitHub
parent 6f94e47270
commit 052145fabd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 15 deletions

View File

@ -267,7 +267,7 @@ class HassIO:
def is_connected(self):
"""Return true if it connected to Hass.io supervisor.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/supervisor/ping", method="get", timeout=15)
@ -275,7 +275,7 @@ class HassIO:
def get_info(self):
"""Return generic Supervisor information.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/info", method="get")
@ -283,7 +283,7 @@ class HassIO:
def get_host_info(self):
"""Return data for Host.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/host/info", method="get")
@ -291,7 +291,7 @@ class HassIO:
def get_os_info(self):
"""Return data for the OS.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/os/info", method="get")
@ -315,7 +315,7 @@ class HassIO:
def get_addon_info(self, addon):
"""Return data for a Add-on.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command(f"/addons/{addon}/info", method="get")
@ -340,7 +340,7 @@ class HassIO:
def get_store(self):
"""Return data from the store.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/store", method="get")
@ -348,7 +348,7 @@ class HassIO:
def get_ingress_panels(self):
"""Return data for Add-on ingress panels.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/ingress/panels", method="get")
@ -356,7 +356,7 @@ class HassIO:
def restart_homeassistant(self):
"""Restart Home-Assistant container.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/homeassistant/restart")
@ -364,7 +364,7 @@ class HassIO:
def stop_homeassistant(self):
"""Stop Home-Assistant container.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/homeassistant/stop")
@ -372,7 +372,7 @@ class HassIO:
def refresh_updates(self):
"""Refresh available updates.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/refresh_updates", timeout=None)
@ -380,7 +380,7 @@ class HassIO:
def retrieve_discovery_messages(self):
"""Return all discovery data from Hass.io API.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/discovery", method="get", timeout=60)
@ -388,7 +388,7 @@ class HassIO:
def get_discovery_message(self, uuid):
"""Return a single discovery data message.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command(f"/discovery/{uuid}", method="get")
@ -396,7 +396,7 @@ class HassIO:
def get_resolution_info(self):
"""Return data for Supervisor resolution center.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/resolution/info", method="get")
@ -424,7 +424,7 @@ class HassIO:
def update_hass_timezone(self, timezone):
"""Update Home-Assistant timezone data on Hass.io.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command("/supervisor/options", payload={"timezone": timezone})
@ -432,7 +432,7 @@ class HassIO:
def update_diagnostics(self, diagnostics: bool):
"""Update Supervisor diagnostics setting.
This method return a coroutine.
This method returns a coroutine.
"""
return self.send_command(
"/supervisor/options", payload={"diagnostics": diagnostics}