summaryrefslogtreecommitdiff
path: root/documentation/pyserial_api.rst
diff options
context:
space:
mode:
authorChris Liechti <cliechti@gmx.net>2016-05-06 23:48:36 +0200
committerChris Liechti <cliechti@gmx.net>2016-05-06 23:48:36 +0200
commit19688bf72d963cd74e7f9ce846c804eafd3ba181 (patch)
tree0814337cf15eb08795ac0f29893264b969332363 /documentation/pyserial_api.rst
parent462002b22581fe0980818c1baf0572d5175a57f6 (diff)
downloadpyserial-git-19688bf72d963cd74e7f9ce846c804eafd3ba181.tar.gz
doc update
Diffstat (limited to 'documentation/pyserial_api.rst')
-rw-r--r--documentation/pyserial_api.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/documentation/pyserial_api.rst b/documentation/pyserial_api.rst
index 4763c6c..e0101d1 100644
--- a/documentation/pyserial_api.rst
+++ b/documentation/pyserial_api.rst
@@ -454,7 +454,8 @@ Native ports
current settings so that a later point in time they can be restored
using :meth:`apply_settings`.
- Note that control lines (RTS/DTR) are part of the settings.
+ Note that the state of control lines (RTS/DTR) are not part of the
+ settings.
.. versionadded:: 2.5
.. versionchanged:: 3.0 renamed from ``getSettingsDict``
@@ -520,7 +521,21 @@ Native ports
.. versionchanged:: 2.7 (renamed on Posix, function was called ``flowControl``)
.. versionchanged:: 3.0 renamed from ``setXON``
+ .. method:: cancel_read()
+ :platform: Windows
+
+ Cancel a pending read operation from an other thread.
+
+ .. versionadded:: 3.1
+
+ .. method:: cancel_write()
+
+ :platform: Windows
+
+ Cancel a pending write operation from an other thread.
+
+ .. versionadded:: 3.1
.. note:: The following members are deprecated and will be removed in a
future release.