From 3c3c9d1456505227cd8a165e8ae9bf762f565707 Mon Sep 17 00:00:00 2001 From: 10kartik Date: Wed, 17 Aug 2022 12:24:48 +0530 Subject: [PATCH 1/2] Fixed Typos in Docs - getting_started --- docs/getting_started.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index a88e1bef..41605e29 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -90,7 +90,7 @@ follows: 1. A :class:`pymemcache.client.hash.HashClient` is created with 3 nodes, ``node1``, ``node2`` and ``node3``. -2. A number of values is set in the client using ``set`` and ``set_many``. +2. A number of values are set in the client using ``set`` and ``set_many``. Example: - ``key1`` -> ``node2`` @@ -120,13 +120,13 @@ follows: Using the built-in retrying mechanism ------------------------------------- -The library comes with retry mechanisms that can be used to wrap all kind of -pymemcache clients. The wrapper allow you to define the exceptions that you want +The library comes with retry mechanisms that can be used to wrap all kinds of +pymemcache clients. The wrapper allows you to define the exceptions that you want to handle with retries, which exceptions to exclude, how many attempts to make and how long to wait between attempts. The ``RetryingClient`` wraps around any of the other included clients and will -have the same methods. For this example we're just using the base ``Client``. +have the same methods. For this example, we're just using the base ``Client``. .. code-block:: python @@ -250,7 +250,7 @@ For testing purpose pymemcache can be used in an interactive mode by using the python interpreter or again ipython and tools like tox. One main advantage of using `tox` to interact with `pymemcache` is that it -comes with it's own virtual environments. It will automatically install +comes with its own virtual environments. It will automatically install pymemcache and fetch all the needed requirements at run. See the example below: .. code-block:: @@ -274,8 +274,8 @@ pymemcache and fetch all the needed requirements at run. See the example below: You can instantiate all the classes and clients offered by pymemcache. Your client will remain open until you decide to close it or until you decide -to quit your interpreter. It can allow you to see what's happen if your server -is abruptly closed. Below is an by example. +to quit your interpreter. It can allow you to see what happens if your server +is abruptly closed. Below is a by-example. Starting your server: @@ -299,7 +299,7 @@ Restarting the server: $ podman restart memcached -The previous client is still opened, now try to retrieve some keys: +The previous client is still open, now try to retrieve some keys: .. code-block:: shell From 70ff711656ad9640a286e3c754d73b98b5a05c37 Mon Sep 17 00:00:00 2001 From: Kartik Kapgate <99239411+10kartik@users.noreply.github.com> Date: Thu, 18 Aug 2022 15:08:57 +0530 Subject: [PATCH 2/2] Update docs/getting_started.rst Co-authored-by: Jon Parise --- docs/getting_started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 41605e29..c2f7bceb 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -275,7 +275,7 @@ You can instantiate all the classes and clients offered by pymemcache. Your client will remain open until you decide to close it or until you decide to quit your interpreter. It can allow you to see what happens if your server -is abruptly closed. Below is a by-example. +is abruptly closed. Below is an example. Starting your server: