From 1cb4eb2285b270229c6a3637fc60bd52f5d6309b Mon Sep 17 00:00:00 2001 From: Brendan Jackman Date: Fri, 27 Jan 2017 19:32:11 +0000 Subject: [PATCH] doc/connection: Document the fact that `pull` supports globs This feature is supported implicitly by SshConnection and explicitly by AdbConnection. A subsequent commit implements it for LocalConnection. --- doc/connection.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/connection.rst b/doc/connection.rst index 25953e5..1fd2fb5 100644 --- a/doc/connection.rst +++ b/doc/connection.rst @@ -31,9 +31,11 @@ class that implements the following methods. .. method:: pull(self, source, dest, timeout=None) - Transfer a file from the connected device to the host machine. + Transfer a file, or files matching a glob pattern, from the connected device + to the host machine. - :param source: path of to the file on the connected device + :param source: path of to the file on the connected device. If ``dest`` is a + directory, may be a glob pattern. :param dest: path of to the file on the host :param timeout: timeout (in seconds) for the transfer; if the transfer does not complete within this period, an exception will be raised.