diff options
| author | Chris Liechti <cliechti@gmx.net> | 2017-03-21 01:54:03 +0100 |
|---|---|---|
| committer | Chris Liechti <cliechti@gmx.net> | 2017-03-21 01:54:03 +0100 |
| commit | bc6031cf906024de2eb7bd06f5917ebdd22cbab8 (patch) | |
| tree | 6d484d5f08496543e1eb6bc5faee0225ef0784e6 /documentation | |
| parent | 4f988d4b79a0328179a15e84bf91cfaf90bfa16d (diff) | |
| download | pyserial-git-bc6031cf906024de2eb7bd06f5917ebdd22cbab8.tar.gz | |
docs: improvements
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/appendix.rst | 6 | ||||
| -rw-r--r-- | documentation/examples.rst | 8 | ||||
| -rw-r--r-- | documentation/pyserial.rst | 4 |
3 files changed, 10 insertions, 8 deletions
diff --git a/documentation/appendix.rst b/documentation/appendix.rst index 80ade6d..57e8e2f 100644 --- a/documentation/appendix.rst +++ b/documentation/appendix.rst @@ -68,7 +68,7 @@ Application works when .py file is run, but fails when packaged (py2exe etc.) used. - :func:`serial.serial_for_url` does a dynamic lookup of protocol handlers - at runtime. If this function is used, the desired handlers have to be + at runtime. If this function is used, the desired handlers have to be included manually (e.g. 'serial.urlhandler.protocol_socket', 'serial.urlhandler.protocol_rfc2217', etc.). This can be done either with the "includes" option in ``setup.py`` or by a dummy import in one of the @@ -93,7 +93,7 @@ User supplied URL handlers Support for Python 2.6 or earlier Support for older Python releases than 2.7 will not return to pySerial 3.x. - Python 2.7 is now many years old (released 2010). If you insist on using + Python 2.7 is now many years old (released 2010). If you insist on using Python 2.6 or earlier, it is recommend to use pySerial `2.7`_ (or any 2.x version). @@ -109,7 +109,7 @@ com0com - http://com0com.sourceforge.net/ License ======= -Copyright (c) 2001-2016 Chris Liechti <cliechti@gmx.net> +Copyright (c) 2001-2017 Chris Liechti <cliechti@gmx.net> All Rights Reserved. Redistribution and use in source and binary forms, with or without diff --git a/documentation/examples.rst b/documentation/examples.rst index 787fd00..0430267 100644 --- a/documentation/examples.rst +++ b/documentation/examples.rst @@ -237,8 +237,10 @@ 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. All test scripts are contained in the directory ``test``. -The unit tests are performed on port ``0`` unless a different device name or -``rfc2217://`` URL is given on the command line (argv[1]). +The unit tests are performed on port ``loop://`` unless a different device +name or URL is given on the command line (``sys.argv[1]``). e.g. to run the +test on an attached USB-serial converter ``hwgrep://USB`` could be used or +the actual name such as ``/dev/ttyUSB0`` or ``COM1`` (depending on platform). run_all_tests.py_ Collect all tests from all ``test*`` files and run them. By default, the @@ -254,7 +256,7 @@ test_high_load.py_ Tests involving sending a lot of data. test_readline.py_ - Tests involving readline. + Tests involving ``readline``. test_iolib.py_ Tests involving the :mod:`io` library. Only available for Python 2.6 and diff --git a/documentation/pyserial.rst b/documentation/pyserial.rst index 602134d..7158dbf 100644 --- a/documentation/pyserial.rst +++ b/documentation/pyserial.rst @@ -48,7 +48,7 @@ Requirements ============ - Python 2.7 or Python 3.4 and newer -- If running on Windows: Something newer than WinXP +- If running on Windows: Windows 7 or newer - If running on Jython: "Java Communications" (JavaComm) or compatible extension for Java @@ -93,7 +93,7 @@ There are also packaged versions for some Linux distributions: - Debian/Ubuntu: "python-serial", "python3-serial" - Fedora / RHEL / CentOS / EPEL: "pyserial" - Arch Linux: "python-pyserial" -- Gento: "dev-python/pyserial" +- Gentoo: "dev-python/pyserial" Note that some distributions may package an older version of pySerial. These packages are created and maintained by developers working on |
