From 520b81e04d7c0140f43b205a9bc31727c07fd152 Mon Sep 17 00:00:00 2001
From: cliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a>
Date: Tue, 18 Aug 2009 00:58:31 +0000
Subject: doc tweaks

git-svn-id: http://svn.code.sf.net/p/pyserial/code/trunk/pyserial@345 f19166aa-fa4f-0410-85c2-fa1106f25c8a
---
 documentation/pyserial_api.rst | 34 ++++++++++++++++++++++------------
 1 file changed, 22 insertions(+), 12 deletions(-)

(limited to 'documentation')

diff --git a/documentation/pyserial_api.rst b/documentation/pyserial_api.rst
index 5f15046..c243559 100644
--- a/documentation/pyserial_api.rst
+++ b/documentation/pyserial_api.rst
@@ -27,12 +27,12 @@ Native ports
 
         :param parity:
             Enable parity checking. Possible values:
-            :const:`PARITY_NONE` :const:`PARITY_EVEN` :const:`PARITY_ODD`
-            :const:`PARITY_MARK` :const:`PARITY_SPACE`
+            :const:`PARITY_NONE`, :const:`PARITY_EVEN`, :const:`PARITY_ODD`
+            :const:`PARITY_MARK`, :const:`PARITY_SPACE`
 
         :param stopbits:
             Number of stop bits. Possible values:
-            :const:`STOPBITS_ONE` :const:`STOPBITS_ONE_POINT_FIVE`
+            :const:`STOPBITS_ONE`, :const:`STOPBITS_ONE_POINT_FIVE`,
             :const:`STOPBITS_TWO`
 
         :param timeout:
@@ -653,29 +653,30 @@ Exceptions
 Constants
 =========
 
-Parity
-------
+*Parity*
+
 .. data:: PARITY_NONE
 .. data:: PARITY_EVEN
 .. data:: PARITY_ODD
 .. data:: PARITY_MARK
 .. data:: PARITY_SPACE
 
-Stop bits
----------
+*Stop bits*
+
 .. data:: STOPBITS_ONE
 .. data:: STOPBITS_ONE_POINT_FIVE
 .. data:: STOPBITS_TWO
 
-Byte size
----------
+*Byte size*
+
 .. data:: FIVEBITS
 .. data:: SIXBITS
 .. data:: SEVENBITS
 .. data:: EIGHTBITS
 
-Others
--------
+
+*Others*
+
 Default control characters (instances of :class:`bytes` for Python 3.0+) for
 software flow control:
 
@@ -688,7 +689,10 @@ Module version:
 
     A string indicating the pySerial version, such as ``2.5``.
 
-Functions:
+    .. versionadded:: 2.3
+
+Module functions
+================
 
 .. function:: device(number)
 
@@ -723,6 +727,7 @@ Functions:
 
     .. versionadded:: 2.5
 
+
 .. _URLs:
 
 URLs
@@ -734,6 +739,11 @@ accept the following types URL:
 - ``socket://<host>:<port>[/<option>[/<option>]]``
 - ``loop://[<option>[/<option>]]``
 
+Device names are also supported:
+
+- ``/dev/ttyUSB0`` (Linux)
+- ``COM3`` (Windows)
+
 (Future releases of pySerial might add more types).
 
 ``rfc2217://``
-- 
cgit v1.2.1