Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixed Typos in Docs #414

Merged
merged 2 commits into from
Aug 18, 2022
Merged

Fixed Typos in Docs #414

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c3c9d1
Fixed Typos in Docs - getting_started
Aug 17, 2022
70ff711
Update docs/getting_started.rst
10kartik Aug 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/getting_started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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::
Expand All @@ -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 an example.

Starting your server:

Expand All @@ -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

Expand Down