diff options
| author | Matthew West <mwest@planetarypower.com> | 2016-07-08 14:27:04 -0700 |
|---|---|---|
| committer | Matthew West <mwest@planetarypower.com> | 2016-07-08 14:27:04 -0700 |
| commit | fa58a97d2782beb32587b11c1846e09f06e26aca (patch) | |
| tree | 1b854859923f31480878fb412fffe64349ee3dd9 | |
| parent | 7ba25cd28839641e4a1db00b2d1c72372e5d18e9 (diff) | |
| download | pyserial-git-fa58a97d2782beb32587b11c1846e09f06e26aca.tar.gz | |
Added documentation for is_open and isOpen.
I'm not sure if isOpen() has been officially deprecated, so I just marked it as such.
| -rw-r--r-- | documentation/pyserial_api.rst | 7 |
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` |