summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-12-26 15:12:03 -0600
committerEugene Triguba <eugenetriguba@gmail.com>2020-12-26 15:12:03 -0600
commit25f3a68f39a9618549ea1fbe7c7b06dd7306af8b (patch)
tree7327fa82a848c568437f244389180fb6ce8a82b4 /docs
parentAdd reply packet parser tests (diff)
downloadlirc-25f3a68f39a9618549ea1fbe7c7b06dd7306af8b.zip
Rename send, start_repeat, and stop_repeat
This now aligns exactly with the calls to lircd.
Diffstat (limited to 'docs')
-rw-r--r--docs/source/usage.rst8
1 files changed, 4 insertions, 4 deletions
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)