diff options
| author | Rob Gaddi <rgaddi@highlandtechnology.com> | 2017-02-24 11:51:37 -0800 |
|---|---|---|
| committer | Rob Gaddi <rgaddi@highlandtechnology.com> | 2017-02-24 11:51:37 -0800 |
| commit | 06db381f702e8ea0700a2c6bb262ef4bad3e4233 (patch) | |
| tree | ef9ae1981c4efbd503a1cb39fd63320605504925 /documentation/pyserial_api.rst | |
| parent | fd59ad4446f754d2f2d3eacd82177b77cd4eedde (diff) | |
| parent | f956057b989e7575492b792e9ee476b19bf4fbc3 (diff) | |
| download | pyserial-git-06db381f702e8ea0700a2c6bb262ef4bad3e4233.tar.gz | |
Merge branch 'master' into v3.2.1-rg
Diffstat (limited to 'documentation/pyserial_api.rst')
| -rw-r--r-- | documentation/pyserial_api.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/documentation/pyserial_api.rst b/documentation/pyserial_api.rst index 3887204..54d2ff3 100644 --- a/documentation/pyserial_api.rst +++ b/documentation/pyserial_api.rst @@ -498,6 +498,8 @@ Native ports .. versionchanged:: 3.0 renamed from ``applySettingsDict`` + .. _context-manager: + This class can be used as context manager. The serial port is closed when the context is left. @@ -579,7 +581,7 @@ Native ports :platform: Posix :platform: Windows - Cancel a pending read operation from an other thread. A blocking + Cancel a pending read operation from another thread. A blocking :meth:`read` call is aborted immediately. :meth:`read` will not report any error but return all data received up to that point (similar to a timeout). @@ -593,7 +595,7 @@ Native ports :platform: Posix :platform: Windows - Cancel a pending write operation from an other thread. The + Cancel a pending write operation from another thread. The :meth:`write` method will return immediately (no error indicated). However the OS may still be sending from the buffer, a separate call to :meth:`reset_output_buffer` may be needed. @@ -1260,7 +1262,7 @@ asyncio ``asyncio`` was introduced with Python 3.4. Experimental support for pySerial is provided via a separate distribution `pyserial-asyncio`_. -It is currently under developement, see: +It is currently under development, see: - http://pyserial-asyncio.readthedocs.io/ - https://github.com/pyserial/pyserial-asyncio |