summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Liechti <cliechti@gmx.net>2016-09-30 23:57:22 +0200
committerChris Liechti <cliechti@gmx.net>2016-09-30 23:57:22 +0200
commitaefbf03f057bbc47cad8c061a6c8e48fe8c9b66b (patch)
tree29c09a299c224e796a783c9fc83bbcfa657231f7
parentc759d297d01138e73f8ecb02bd8c5bfccf528077 (diff)
downloadpyserial-git-aefbf03f057bbc47cad8c061a6c8e48fe8c9b66b.tar.gz
docs: extend notes on open()
-rw-r--r--documentation/pyserial_api.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/documentation/pyserial_api.rst b/documentation/pyserial_api.rst
index 92b42e5..cec0078 100644
--- a/documentation/pyserial_api.rst
+++ b/documentation/pyserial_api.rst
@@ -111,15 +111,21 @@ Native ports
.. method:: open()
- Open port. The state of :attr:`rts`` and :attr:`dtr` is applied.
-
+ Open port. The state of :attr:`rts` and :attr:`dtr` is applied.
+
.. note::
-
+
Some OS and/or drivers may activate RTS and or DTR automatically,
as soon as the port is opened. There may be a glitch on RTS/DTR
when :attr:`rts`` or :attr:`dtr` are set differently from their
default value (``True`` / active).
+ .. note::
+
+ For compatibility reasons, no error is reported when applying
+ :attr:`rts` or :attr:`dtr` fails on POSIX due to EINVAL (22) or
+ ENOTTY (25).
+
.. method:: close()
Close port immediately.
@@ -283,7 +289,7 @@ Native ports
Return the state of the CD line
.. attribute:: is_open
-
+
:getter: Get the state of the serial port, whether it's open.
:type: bool