summaryrefslogtreecommitdiff
path: root/documentation/pyserial_api.rst
diff options
context:
space:
mode:
authorChris Liechti <cliechti@gmx.net>2015-12-17 19:43:59 +0100
committerChris Liechti <cliechti@gmx.net>2015-12-17 19:43:59 +0100
commit9ad044afd3ba15749178adb27af2591f2bb1c054 (patch)
tree9af7ec4ae712300b70259a43201d199560a29586 /documentation/pyserial_api.rst
parent3e02f7052747521a21723a618dccf303065da732 (diff)
downloadpyserial-git-9ad044afd3ba15749178adb27af2591f2bb1c054.tar.gz
doc update
Diffstat (limited to 'documentation/pyserial_api.rst')
-rw-r--r--documentation/pyserial_api.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/documentation/pyserial_api.rst b/documentation/pyserial_api.rst
index 1b15762..a3f2ae8 100644
--- a/documentation/pyserial_api.rst
+++ b/documentation/pyserial_api.rst
@@ -139,7 +139,9 @@ Native ports
In case a write timeout is configured for the port and the time is
exceeded.
- Write the string *data* to the port.
+ Write the bytes *data* to the port. This should be of type ``bytes``
+ (or compatible such as ``bytearray`` or ``memoryview``). Unicode
+ strings must be encoded (e.g. ``'hello'.encode('utf-8'``).
.. versionchanged:: 2.5
Accepts instances of :class:`bytes` and :class:`bytearray` when