From 5e30f09c34a8d0cfaff105eb637ddf20413bd165 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sun, 18 Apr 2021 18:26:39 -0500 Subject: Clean up some docstrings --- lirc/client.py | 22 +++++++++++----------- lirc/connection/lircd_connection.py | 24 ++++++++++-------------- 2 files changed, 21 insertions(+), 25 deletions(-) diff --git a/lirc/client.py b/lirc/client.py index bbdf1bd..84b98c9 100644 --- a/lirc/client.py +++ b/lirc/client.py @@ -109,9 +109,9 @@ class Client: Send an lircd SEND_STOP command. The remote and key default to the remote and key - last used with send_start if they are not specified, - since the most likely use case is sending a send_start - and then a send_stop. + last used with ``send_start`` if they are not specified, + since the most likely use case is sending a ``send_start`` + and then a ``send_stop``. Args: remote: The remote to stop. @@ -131,7 +131,7 @@ class Client: def list_remotes(self) -> List[str]: """ List all the remotes that lirc has in - its `lircd.conf.d` folder. + its ``/etc/lirc/lircd.conf.d`` folder. Raises: LircdCommandFailure: If the command fails. @@ -211,19 +211,19 @@ class Client: """ Simulate an IR event. - The --allow-simulate command line option to `lircd` must be active for this + The ``--allow-simulate`` command line option to lircd must be active for this command not to fail. - Example Format: + Lircd Format: