diff options
| author | Chris Liechti <cliechti@gmx.net> | 2019-02-08 01:22:50 +0100 |
|---|---|---|
| committer | Chris Liechti <cliechti@gmx.net> | 2019-02-08 01:22:50 +0100 |
| commit | ba3f6e73bb68566ada43411a42140e53558ab353 (patch) | |
| tree | 02592b0b1aa8cabcbce4d7f5bcb6ba787db4bc1c | |
| parent | 86ae7f9323be04b2950e64f463c470ebd3443641 (diff) | |
| download | pyserial-git-ba3f6e73bb68566ada43411a42140e53558ab353.tar.gz | |
docs: mention "seconds" in "send_break" and "__init__" docs
fixes #397
| -rw-r--r-- | documentation/pyserial_api.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/documentation/pyserial_api.rst b/documentation/pyserial_api.rst index d9dcb32..76177dd 100644 --- a/documentation/pyserial_api.rst +++ b/documentation/pyserial_api.rst @@ -36,7 +36,7 @@ Native ports :const:`STOPBITS_TWO` :param float timeout: - Set a read timeout value. + Set a read timeout value in seconds. :param bool xonxoff: Enable software flow control. @@ -48,7 +48,7 @@ Native ports Enable hardware (DSR/DTR) flow control. :param float write_timeout: - Set a write timeout value. + Set a write timeout value in seconds. :param float inter_byte_timeout: Inter-character timeout, :const:`None` to disable (default). @@ -237,7 +237,7 @@ Native ports .. method:: send_break(duration=0.25) - :param float duration: Time to activate the BREAK condition. + :param float duration: Time in seconds, to activate the BREAK condition. Send break condition. Timed, returns to idle state after given duration. |