summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--CHANGELOG.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index b650f3d..ade2370 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -14,21 +14,21 @@ Unreleased
**Changed**
- ``socket_path`` in ``Lirc``'s constructor is now called ``address`` to better signify
- what is it for (the address to reach lircd). This allows it to make more sense in a
- cross-platform context such as with WinLIRC since TCP is used there and not a socket.
+ what is it for (the address to reach lircd). This allows it to make more sense in a
+ cross-platform context such as with WinLIRC since TCP is used there and not a socket.
- ``address`` in ``Lirc``'s constructor is now type hinted to be a tuple or a string.
- A tuple is used for a TCP connection since you'd specify it as such: ("localhost", 8765).
+ A tuple is used for a TCP connection since you'd specify it as such: ("localhost", 8765).
- ``socket_timeout`` has been renamed to just ``timeout`` in ``Lirc``'s constructor to clarify
- that it may not necessarily be a socket (in the case of being on Windows).
+ that it may not necessarily be a socket (in the case of being on Windows).
- ``socket_timeout`` in ``Lirc``'s constructor is now type hinted as a float instead of an int.
- This is the type that the socket will change it to anyway, and it makes more sense with time.
+ This is the type that the socket will change it to anyway, and it makes more sense with time.
- ``socket`` and ``address`` in ``Lirc``'s constructor is now defaulted to ``None`` in the ``__init__``
- method, but it does some calculations to determine the operating system that it is being run on and
- sets up sensible defaults for them based on that.
+ method, but it does some calculations to determine the operating system that it is being run on and
+ sets up sensible defaults for them based on that.
- On Linux, it is "/var/run/lirc/lircd" as the address.
On macOS, it is "/opt/run/var/run/lirc/lircd".
@@ -47,4 +47,4 @@ Unreleased
0.1.0 - 2020-07-13
------------------
-- Initial Release \ No newline at end of file
+- Initial Release