diff options
| author | Chris Liechti <cliechti@gmx.net> | 2016-05-05 23:54:35 +0200 |
|---|---|---|
| committer | Chris Liechti <cliechti@gmx.net> | 2016-05-05 23:54:35 +0200 |
| commit | 06ae1dcb083ae3c04ddb1c3ac41374afff8027f6 (patch) | |
| tree | 6cdd0ad70578190a34aedaa4953a6afa6129d057 /documentation | |
| parent | 2c278a867174337d26da3d0a9d26066698b0e0fd (diff) | |
| download | pyserial-git-06ae1dcb083ae3c04ddb1c3ac41374afff8027f6.tar.gz | |
doc update
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/appendix.rst | 2 | ||||
| -rw-r--r-- | documentation/conf.py | 2 | ||||
| -rw-r--r-- | documentation/tools.rst | 4 | ||||
| -rw-r--r-- | documentation/url_handlers.rst | 5 |
4 files changed, 7 insertions, 6 deletions
diff --git a/documentation/appendix.rst b/documentation/appendix.rst index f092d98..5d8bae0 100644 --- a/documentation/appendix.rst +++ b/documentation/appendix.rst @@ -81,7 +81,7 @@ com0com - http://com0com.sourceforge.net/ License ======= -Copyright (c) 2001-2015 Chris Liechti <cliechti@gmx.net> +Copyright (c) 2001-2016 Chris Liechti <cliechti@gmx.net> All Rights Reserved. Redistribution and use in source and binary forms, with or without diff --git a/documentation/conf.py b/documentation/conf.py index 3a2d23e..27f12c4 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -38,7 +38,7 @@ master_doc = 'index' # General information about the project. project = u'pySerial' -copyright = u'2001-2015, Chris Liechti' +copyright = u'2001-2016, Chris Liechti' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/documentation/tools.rst b/documentation/tools.rst index 6431430..45e7aef 100644 --- a/documentation/tools.rst +++ b/documentation/tools.rst @@ -14,9 +14,9 @@ serial.tools.list_ports``). It also contains the following functions. .. function:: comports() - :return: an iterable that yields :class:`ListPortInfo` objects. + :return: a list containing :class:`ListPortInfo` objects. - The function returns an iterable that yields :obj:`ListPortInfo` objects. + The function returns a list of :obj:`ListPortInfo` objects. Items are returned in no particular order. It may make sense to sort the items. Also note that the reported strings are different across platforms diff --git a/documentation/url_handlers.rst b/documentation/url_handlers.rst index e9c5efc..ae331f9 100644 --- a/documentation/url_handlers.rst +++ b/documentation/url_handlers.rst @@ -15,6 +15,7 @@ The function :func:`serial_for_url` accepts the following types of URLs: - ``loop://[?logging={debug|info|warning|error}]`` - ``hwgrep://<regexp>[&skip_busy][&n=N]`` - ``spy://port[?option[=value][&option[=value]]]`` +- ``alt://port?class=<classname>`` .. versionchanged:: 3.0 Options are specified with ``?`` and ``&`` instead of ``/`` @@ -105,11 +106,11 @@ Note that options are separated using the character ``&``, this also applies to the first, where URLs usually use ``?``. This exception is made as the question mark is used in regexp itself. -Depending on the capabilities of the list_ports module on the system, it is +Depending on the capabilities of the ``list_ports`` module on the system, it is possible to search for the description or hardware ID of a device, e.g. USB VID:PID or texts. -Unfortunately, on some systems list_ports only lists a subset of the port +Unfortunately, on some systems ``list_ports`` only lists a subset of the port names with no additional information. Currently, on Windows and Linux and OSX it should find additional information. |