summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-07-13 22:58:12 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2020-07-13 22:58:12 -0500
commit2beaaa0fce51bc953aab267f1b0fb9ab4a8c1ecb (patch)
treef66793a912cb4533287b4cedfd9669d237c3df4c
parentUse poetry for uploading to pypi on github action (diff)
downloadlirc-2beaaa0fce51bc953aab267f1b0fb9ab4a8c1ecb.zip
Document exception that could be thrown if socket_path is not found
-rw-r--r--lirc/lirc.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/lirc/lirc.py b/lirc/lirc.py
index f0ab749..a60c869 100644
--- a/lirc/lirc.py
+++ b/lirc/lirc.py
@@ -30,6 +30,8 @@ class Lirc:
:param socket: The socket.socket used to connect to the lircd socket.
:param socket_timeout: The amount of time to wait before timing out when
receiving data.
+
+ :raises FileNotFoundError: If the socket path is not found.
"""
self.__lock = threading.Lock()
self.__socket = socket