summaryrefslogtreecommitdiff
path: root/pygerrit/ssh.py
diff options
context:
space:
mode:
authorDavid Pursehouse <david.pursehouse@sonymobile.com>2013-08-02 17:50:28 +0900
committerDavid Pursehouse <david.pursehouse@sonymobile.com>2013-08-04 14:27:50 +0900
commit3bcab572e30115ab42e5b96e6054f9b60b44a75c (patch)
tree10382541c8896a36a26cbc036453fc861d90b79b /pygerrit/ssh.py
parentc79860036c63f06ab30a7560a8e1d3ea186d508e (diff)
downloadpygerrit-3bcab572e30115ab42e5b96e6054f9b60b44a75c.tar.gz
Add missing docstrings to conform to PEP-257
Change-Id: If06f1ea17740a796142db63e7086f80445f4c6e1
Diffstat (limited to 'pygerrit/ssh.py')
-rw-r--r--pygerrit/ssh.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/pygerrit/ssh.py b/pygerrit/ssh.py
index 270a63f..0436165 100644
--- a/pygerrit/ssh.py
+++ b/pygerrit/ssh.py
@@ -35,7 +35,12 @@ from paramiko.ssh_exception import SSHException
def _extract_version(version_string, pattern):
- """ Extract the version from `version_string` using `pattern`. """
+ """ Extract the version from `version_string` using `pattern`.
+
+ Return the version as a string, with leading/trailing whitespace
+ stripped.
+
+ """
if version_string:
match = pattern.match(version_string.strip())
if match: