From 25f3a68f39a9618549ea1fbe7c7b06dd7306af8b Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 26 Dec 2020 15:12:03 -0600 Subject: Rename send, start_repeat, and stop_repeat This now aligns exactly with the calls to lircd. --- docs/source/usage.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/source/usage.rst') diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 9302e08..6b65451 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -86,11 +86,11 @@ the ``lirc.Client``. import lirc client = lirc.Client() - client.send('our-remote-name', 'key-in-the-remote-file') + client.send_once('our-remote-name', 'key-in-the-remote-file') -Using the ``send()`` method is quite simple. For any method, such as this one, that +Using the ``send_once()`` method is quite simple. For any method, such as this one, that takes in a remote and a key, the parameters are always in that order with the remote -name first and then the key name. Because the ``send`` method does not get any meaningful +name first and then the key name. Because the ``send_once`` method does not get any meaningful data back from lircd, there is no return value from it. Instead, as is the case for most methods here that don't have a meaningful return value, a ``lirc.LircdCommandFailureError`` is raised if the command we sent failed. @@ -100,5 +100,5 @@ want to go to channel 33. .. code-block:: python - client.send('our-remote-name', 'key_3', repeat_count=2) + client.send_once('our-remote-name', 'key_3', repeat_count=2) -- cgit v1.2.3