summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorcliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a>2009-08-03 00:34:03 +0000
committercliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a>2009-08-03 00:34:03 +0000
commit8611bf4863dd9fd60c5285ce7c3b71fe93ce6d0d (patch)
treec83c01f332e3a72619e1595f58a0fb8f77ed5492
parent27aeb5d284d48a1a8df0e7b68d233462473e22e6 (diff)
downloadpyserial-git-8611bf4863dd9fd60c5285ce7c3b71fe93ce6d0d.tar.gz
doc updates and typos fixed
-rw-r--r--pyserial/documentation/examples.rst6
-rw-r--r--pyserial/documentation/pyserial_api.rst17
2 files changed, 16 insertions, 7 deletions
diff --git a/pyserial/documentation/examples.rst b/pyserial/documentation/examples.rst
index 283f2d6..a925ea8 100644
--- a/pyserial/documentation/examples.rst
+++ b/pyserial/documentation/examples.rst
@@ -78,6 +78,9 @@ running shows the help text::
--- x X disable/enable software flow control
--- r R disable/enable hardware flow control
+.. versionchanged:: 2.5
+ Added :kbd:`Control+t` menu and added support for opening :rfc:`2217` ports
+ (use ``rfc2217:://<host>:<port>`` as *port* argument when invoking).
miniterm.py_
The miniterm program.
@@ -263,6 +266,9 @@ Unit tests
The project uses a number of unit test to verify the functionality. They all
need a loop back connector. The scripts itself contain more information.
+The unit tests are performed on port ``0`` unless a different device name or
+rfc2217 URL is given on the command line (argv[1]).
+
test.py_
Basic tests.
diff --git a/pyserial/documentation/pyserial_api.rst b/pyserial/documentation/pyserial_api.rst
index 22e519c..97bf3ee 100644
--- a/pyserial/documentation/pyserial_api.rst
+++ b/pyserial/documentation/pyserial_api.rst
@@ -67,6 +67,9 @@ Classes
- ``timeout = 0``: non-blocking mode (return immediately on read)
- ``timeout = x``: set timeout to ``x`` seconds (float allowed)
+ Note that enabling both flow control methods (*xonxoff* and *rtscts*)
+ together may not be supported. It is common to use one of the methods
+ at once, not both.
.. method:: open()
@@ -91,7 +94,7 @@ Classes
.. versionchanged:: 2.5
Returns an instance of :class:`bytes` when available (Python 2.6
- and newer) and :class:`str` otherwiese.
+ and newer) and :class:`str` otherwise.
.. method:: write(data)
@@ -105,7 +108,7 @@ Classes
.. versionchanged:: 2.5
Accepts instances of :class:`bytes` and :class:`bytearray` when
- available (Python 2.6 and newer) and :class:`str` otherwiese.
+ available (Python 2.6 and newer) and :class:`str` otherwise.
.. method:: inWaiting()
@@ -375,10 +378,10 @@ Classes
.. method:: readinto(b)
- :param b: bytearray or array instace
+ :param b: bytearray or array instance
:return: Number of byte read
- Read up to len(b) bytes into bytearray b and return the number of bytes read.
+ Read up to len(b) bytes into bytearray *b* and return the number of bytes read.
.. versionadded:: 2.5
@@ -498,8 +501,8 @@ Classes
Not implemented yet / Possible problems with the implementation:
- - :rfc:`2217` flow control between client and server. (objects internal
- buffer may eat all your memory when never read)
+ - :rfc:`2217` flow control between client and server (objects internal
+ buffer may eat all your memory when never read).
.. versionadded:: 2.5
@@ -550,7 +553,7 @@ Byte size
Others
-------
-Default control characters (instnces of :class:`bytes` for Python 3.0+) for
+Default control characters (instances of :class:`bytes` for Python 3.0+) for
software flow control:
.. data:: XON