diff options
Diffstat (limited to 'pyecsca/sca/target/serial.py')
| -rw-r--r-- | pyecsca/sca/target/serial.py | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/pyecsca/sca/target/serial.py b/pyecsca/sca/target/serial.py index a435ca0..fba5d69 100644 --- a/pyecsca/sca/target/serial.py +++ b/pyecsca/sca/target/serial.py @@ -1,6 +1,4 @@ -""" -This module provides an abstract serial target, that communicates by writing and reading a stream of bytes. -""" +"""This module provides an abstract serial target, that communicates by writing and reading a stream of bytes.""" from abc import abstractmethod from public import public @@ -10,12 +8,12 @@ from .base import Target @public class SerialTarget(Target): - """A serial target.""" + """Serial target.""" @abstractmethod def write(self, data: bytes) -> None: """ - Write the `data` bytes to the target's serial input. + Write the :paramref:`~.write.data` bytes to the target's serial input. :param data: The data to write. """ @@ -24,9 +22,9 @@ class SerialTarget(Target): @abstractmethod def read(self, num: int = 0, timeout: int = 0) -> bytes: """ - Read upto `num` bytes or until `timeout` milliseconds from the target's serial output. + Read upto :paramref:`~.read.num` bytes or until :paramref:`~.read.timeout` milliseconds from the target's serial output. - :param num: The number of bytes to read, `0` for all available. + :param num: The number of bytes to read, ``0`` for all available. :param timeout: The timeout in milliseconds. :return: The bytes read. """ |