summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzsquareplusc <cliechti@gmx.net>2016-07-10 21:14:50 +0200
committerGitHub <noreply@github.com>2016-07-10 21:14:50 +0200
commit26fb4947318a65b6b71f1ec40cf88230f1c95b90 (patch)
tree1b854859923f31480878fb412fffe64349ee3dd9
parent7ba25cd28839641e4a1db00b2d1c72372e5d18e9 (diff)
parentfa58a97d2782beb32587b11c1846e09f06e26aca (diff)
downloadpyserial-git-26fb4947318a65b6b71f1ec40cf88230f1c95b90.tar.gz
Merge pull request #140 from MatthewWest/master
Added documentation for is_open and isOpen.
-rw-r--r--documentation/pyserial_api.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/documentation/pyserial_api.rst b/documentation/pyserial_api.rst
index 2aa8d21..a3417c2 100644
--- a/documentation/pyserial_api.rst
+++ b/documentation/pyserial_api.rst
@@ -275,6 +275,9 @@ Native ports
Return the state of the CD line
+ .. attribute:: is_open
+ :getter: Get the state of the serial port, whether it's open.
+ :type: bool
New values can be assigned to the following attributes (properties), the
port will be reconfigured, even if it's opened at that time:
@@ -564,6 +567,10 @@ Native ports
.. deprecated:: 3.0 see :attr:`in_waiting`
+ .. method:: isOpen()
+
+ .. deprecated:: 3.0 see :attr:`is_open`
+
.. attribute:: writeTimeout
.. deprecated:: 3.0 see :attr:`write_timeout`