From fafff23447578f771f7c879c1bd50986c3f9006f Mon Sep 17 00:00:00 2001 From: Tim Gates Date: Sat, 20 Nov 2021 13:39:25 +1100 Subject: [PATCH] docs: Fix a few typos There are small typos in: - consul/base.py - tests/test_twisted.py Fixes: - Should read `perform` rather than `peform`. - Should read `twisted` rather than `twsited`. - Should read `synchronization` rather than `syncronization`. - Should read `parameter` rather than `paramater`. --- consul/base.py | 8 ++++---- tests/test_twisted.py | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/consul/base.py b/consul/base.py index ee6ab254..a4d3b062 100755 --- a/consul/base.py +++ b/consul/base.py @@ -52,7 +52,7 @@ class Check(object): @classmethod def script(klass, args, interval): """ - Run the script *args* every *interval* (e.g. "10s") to peform health + Run the script *args* every *interval* (e.g. "10s") to perform health check """ if isinstance(args, six.string_types) \ @@ -65,11 +65,11 @@ def script(klass, args, interval): @classmethod def http(klass, url, interval, timeout=None, deregister=None, header=None): """ - Peform a HTTP GET against *url* every *interval* (e.g. "10s") to peform + Perform a HTTP GET against *url* every *interval* (e.g. "10s") to perform health check with an optional *timeout* and optional *deregister* after which a failing service will be automatically deregistered. Optional parameter *header* specifies headers sent in HTTP request. *header* - paramater is in form of map of lists of strings, + parameter is in form of map of lists of strings, e.g. {"x-foo": ["bar", "baz"]}. """ ret = {'http': url, 'interval': interval} @@ -572,7 +572,7 @@ def put( The optional *cas* parameter is used to turn the PUT into a Check-And-Set operation. This is very useful as it allows clients - to build more complex syncronization primitives on top. If the + to build more complex synchronization primitives on top. If the index is 0, then Consul will only put the key if it does not already exist. If the index is non-zero, then the key is only set if the index matches the ModifyIndex of that key. diff --git a/tests/test_twisted.py b/tests/test_twisted.py index 097674c5..b6e4f306 100644 --- a/tests/test_twisted.py +++ b/tests/test_twisted.py @@ -13,7 +13,7 @@ def sleep(seconds): """ - An asynchronous sleep function using twsited. Source: + An asynchronous sleep function using twisted. Source: http://twistedmatrix.com/pipermail/twisted-python/2009-October/020788.html :type seconds: float