From 09d0a0f5009fc548bc405c69e5b3f680fb0389a4 Mon Sep 17 00:00:00 2001 From: Marc Bonnici Date: Wed, 31 Mar 2021 10:07:55 +0100 Subject: [PATCH] docs: Fix Formatting / typos --- doc/connection.rst | 4 ++-- doc/target.rst | 13 +++++++------ 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/connection.rst b/doc/connection.rst index 1c5872e..34a86cd 100644 --- a/doc/connection.rst +++ b/doc/connection.rst @@ -147,7 +147,7 @@ Connection Types .. class:: SshConnection(host, username, password=None, keyfile=None, port=22,\ timeout=None, platform=None, \ sudo_cmd="sudo -- sh -c {}", strict_host_check=True, \ - use_scp=False, poll_transfers=False, + use_scp=False, poll_transfers=False, \ start_transfer_poll_delay=30, total_transfer_timeout=3600,\ transfer_poll_period=30) @@ -177,7 +177,7 @@ Connection Types :param platform: Specify the platform to be used. The generic :class:`~devlib.platform.Platform` class is used by default. :param sudo_cmd: Specify the format of the command used to grant sudo access. - :param strict_host_check: Specify the ssh connection parameter ``StrictHostKeyChecking``, + :param strict_host_check: Specify the ssh connection parameter ``StrictHostKeyChecking``, :param use_scp: Use SCP for file transfers, defaults to SFTP. :param poll_transfers: Specify whether file transfers should be polled. Polling monitors the progress of file transfers and periodically diff --git a/doc/target.rst b/doc/target.rst index a53af8a..18aa4d7 100644 --- a/doc/target.rst +++ b/doc/target.rst @@ -225,15 +225,16 @@ Target If transfer polling is supported (ADB connections and SSH connections), ``poll_transfers`` is set in the connection, and a timeout is not specified, the push will be polled for activity. Inactive transfers will be - cancelled. (See :ref:`connection-types`\ for more information on polling). + cancelled. (See :ref:`connection-types` for more information on polling). :param source: path on the host :param dest: path on the target :param as_root: whether root is required. Defaults to false. :param timeout: timeout (in seconds) for the transfer; if the transfer does - not complete within this period, an exception will be raised. + not complete within this period, an exception will be raised. Leave unset + to utilise transfer polling if enabled. :param globbing: If ``True``, the ``source`` is interpreted as a globbing - pattern instead of being take as-is. If the pattern has mulitple + pattern instead of being take as-is. If the pattern has multiple matches, ``dest`` must be a folder (or will be created as such if it does not exists yet). @@ -244,7 +245,7 @@ Target If transfer polling is supported (ADB connections and SSH connections), ``poll_transfers`` is set in the connection, and a timeout is not specified, the pull will be polled for activity. Inactive transfers will be - cancelled. (See :ref:`connection-types`\ for more information on polling). + cancelled. (See :ref:`connection-types` for more information on polling). :param source: path on the target :param dest: path on the host @@ -252,7 +253,7 @@ Target :param timeout: timeout (in seconds) for the transfer; if the transfer does not complete within this period, an exception will be raised. :param globbing: If ``True``, the ``source`` is interpreted as a globbing - pattern instead of being take as-is. If the pattern has mulitple + pattern instead of being take as-is. If the pattern has multiple matches, ``dest`` must be a folder (or will be created as such if it does not exists yet). @@ -706,7 +707,7 @@ Android Target .. method:: AndroidTarget.get_stay_on_mode() Returns an integer between ``0`` and ``7`` representing the current - stay-on mode of the device. + stay-on mode of the device. .. method:: AndroidTarget.ensure_screen_is_off(verify=True)