Skip to content

Commit 26fb494

Browse files
authored
Merge pull request pyserial#140 from MatthewWest/master
Added documentation for is_open and isOpen.
2 parents 7ba25cd + fa58a97 commit 26fb494

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

documentation/pyserial_api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,9 @@ Native ports
275275

276276
Return the state of the CD line
277277

278+
.. attribute:: is_open
279+
:getter: Get the state of the serial port, whether it's open.
280+
:type: bool
278281

279282
New values can be assigned to the following attributes (properties), the
280283
port will be reconfigured, even if it's opened at that time:
@@ -564,6 +567,10 @@ Native ports
564567

565568
.. deprecated:: 3.0 see :attr:`in_waiting`
566569

570+
.. method:: isOpen()
571+
572+
.. deprecated:: 3.0 see :attr:`is_open`
573+
567574
.. attribute:: writeTimeout
568575

569576
.. deprecated:: 3.0 see :attr:`write_timeout`

0 commit comments

Comments
 (0)