From 5584bb4e6fc5747b4ee91eab1266d2876a515588 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Wed, 24 Dec 2014 04:20:14 +0100 Subject: [PATCH 1/2] fix param names in docstrings to match actual param names --- letsencrypt/client/apache/configurator.py | 4 ++-- letsencrypt/client/apache/parser.py | 3 +-- letsencrypt/client/challenge_util.py | 2 +- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/letsencrypt/client/apache/configurator.py b/letsencrypt/client/apache/configurator.py index 2e2a02238..12dac92a3 100644 --- a/letsencrypt/client/apache/configurator.py +++ b/letsencrypt/client/apache/configurator.py @@ -201,7 +201,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): .. todo:: This should maybe return list if no obvious answer is presented. - :param str name: domain name + :param str target_name: domain name :returns: ssl vhost associated with name :rtype: :class:`letsencrypt.client.apache.obj.VirtualHost` @@ -348,7 +348,7 @@ class ApacheConfigurator(augeas_configurator.AugeasConfigurator): now NameVirtualHosts. If version is earlier than 2.4, check if addr has a NameVirtualHost directive in the Apache config - :param str addr: vhost address ie. \*:443 + :param str target_addr: vhost address ie. \*:443 :returns: Success :rtype: bool diff --git a/letsencrypt/client/apache/parser.py b/letsencrypt/client/apache/parser.py index 9d92e9271..8a0a9aff9 100644 --- a/letsencrypt/client/apache/parser.py +++ b/letsencrypt/client/apache/parser.py @@ -342,8 +342,7 @@ class ApacheParser(object): .. todo:: This will have to be updated for other distros versions - :param str filename: optional filename that will be used as the - user config + :param str root: pathname which contains the user config """ # Basic check to see if httpd.conf exists and diff --git a/letsencrypt/client/challenge_util.py b/letsencrypt/client/challenge_util.py index 46b0602be..26266cda1 100644 --- a/letsencrypt/client/challenge_util.py +++ b/letsencrypt/client/challenge_util.py @@ -15,7 +15,7 @@ def dvsni_gen_cert(filepath, name, r_b64, nonce, key): :param str filepath: destination to save certificate. This will overwrite any file that is currently at the location. :param str name: domain to validate - :param str dvsni_r: jose base64 encoded dvsni r value + :param str r_b64: jose base64 encoded dvsni r value :param str nonce: hex value of nonce :param key: Key to perform challenge From 992830f2c239469173b525edbd072df8864d005d Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Wed, 24 Dec 2014 04:42:03 +0100 Subject: [PATCH 2/2] fix typos, including a severe one --- letsencrypt/client/apache/parser.py | 4 ++-- letsencrypt/client/display.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/letsencrypt/client/apache/parser.py b/letsencrypt/client/apache/parser.py index 8a0a9aff9..f2516a49e 100644 --- a/letsencrypt/client/apache/parser.py +++ b/letsencrypt/client/apache/parser.py @@ -346,14 +346,14 @@ class ApacheParser(object): """ # Basic check to see if httpd.conf exists and - # in heirarchy via direct include + # in hierarchy via direct include # httpd.conf was very common as a user file in Apache 2.2 if (os.path.isfile(os.path.join(self.root, 'httpd.conf')) and self.find_dir( case_i("Include"), case_i("httpd.conf"), root)): return os.path.join(self.root, 'httpd.conf') else: - return os.path.join(self.root + 'apache2.conf') + return os.path.join(self.root, 'apache2.conf') def case_i(string): diff --git a/letsencrypt/client/display.py b/letsencrypt/client/display.py index c6d90b5f0..29b646794 100644 --- a/letsencrypt/client/display.py +++ b/letsencrypt/client/display.py @@ -182,7 +182,7 @@ class FileDisplay(object): else: try: selection = int(ans) - # TODO add check to make sure it is liess than max + # TODO add check to make sure it is less than max if selection < 0: self.outfile.write(e_msg) continue