Skip to content

Commit

Permalink
Spelling, grammar and small docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
hannosch committed Jul 12, 2012
1 parent be2743a commit 5dcc08f
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 17 deletions.
1 change: 1 addition & 0 deletions docs/basic_usage.rst
Expand Up @@ -4,3 +4,4 @@
Basic Usage
===========

TODO - not yet written
2 changes: 1 addition & 1 deletion docs/glossary.rst
Expand Up @@ -6,7 +6,7 @@ Glossary

.. glossary::

zookeeper
Zookeeper
`Apache Zookeeper <http://zookeeper.apache.org/>`_ is a centralized
service for maintaining configuration information, naming, providing
distributed synchronization, and providing group services.
14 changes: 7 additions & 7 deletions docs/index.rst
Expand Up @@ -10,23 +10,23 @@ Pythonic manner, and is compatible with async environments like `gevent`_.
Installing
==========

kazoo can be installed via ``easy_install`` or ``pip``:
kazoo can be installed via ``pip`` or ``easy_install``:

.. code-block:: bash
$ easy_install kazoo
$ pip install kazoo
You will also need the Python zookeeper C binding installed. There's an
easy to install staticly compiled version:
You will also need the Python Zookeeper C binding installed. There's an
easy to install statically compiled version:

.. code-block:: bash
$ easy_install zc-zookeeper-static
$ pip install zc-zookeeper-static
Or if your OS distribution includes a python-zookeeper package, that can
be installed. Unless you're using a recent ubuntu, its recommended that you use
be installed. Unless you're using a recent Ubuntu, its recommended that you use
the static library above as it includes some memory leak patches that are not
necessarilly in python zookeeper OS distributions.
necessarily in Python Zookeeper OS distributions.

Reference Material
==================
Expand Down
4 changes: 2 additions & 2 deletions docs/introduction.rst
Expand Up @@ -5,8 +5,8 @@ Introducing Kazoo
=================

Kazoo is a Python library designed to make working with :term:`Zookeeper` a
more hassle-free experience less prone to errors. Using :term:`Zookeeper` in a
safe manner can be difficult due to the variety of edge-cases in
more hassle-free experience and less prone to errors. Using :term:`Zookeeper`
in a safe manner can be difficult due to the variety of edge-cases in
:term:`Zookeeper` and other bugs that have been present in the Python C
binding. Due to how the C library utilizes a separate C thread for
:term:`Zookeeper` communication some libraries like `gevent`_ also don't work
Expand Down
2 changes: 1 addition & 1 deletion kazoo/client.py
Expand Up @@ -374,7 +374,7 @@ def __init__(self, hosts='127.0.0.1:2181', watcher=None,
:param handler: An instance of a class implementing the
:class:`~kazoo.interfaces.IHandler` interface
for callback handling
:param default_acl: A default ACL used on node creation.
"""
from kazoo.recipe.partitioner import SetPartitioner

Expand Down
2 changes: 1 addition & 1 deletion kazoo/handlers/util.py
@@ -1,4 +1,4 @@
"""Handler utilities for getting non-monkey patched std lib stuff
"""Handler utilities for getting non-monkey patched standard library stuff.
Allows one to get an unpatched thread module, with a thread
decorator that uses the unpatching OS thread.
Expand Down
10 changes: 5 additions & 5 deletions kazoo/recipe/partitioner.py
Expand Up @@ -65,7 +65,7 @@ class SetPartitioner(object):
This class will partition a set amongst members of a party such
that each party will be given one or more members of the set and
each set item will be given to a single member. When new members
enter or leave the party, the set will be re-partioned amongst the
enter or leave the party, the set will be re-partitioned amongst the
members.
When the :class:`SetPartitioner` enters the
Expand Down Expand Up @@ -131,13 +131,13 @@ def use_setlist(partitions):
Allocating the set failed either due to a Zookeeper session
expiration, or failure to acquire the partition members of the
set withing the timeout period.
set within the timeout period.
:attr:`~PartitionState.ACQUIRED` ->
:attr:`~PartitionState.RELEASE`
The members of the party has changed, and the set needs to be
repartioned. :meth:`SetPartitioner.release` should be called
The members of the party have changed, and the set needs to be
repartitioned. :meth:`SetPartitioner.release` should be called
as soon as possible.
:attr:`~PartitionState.ACQUIRED` ->
Expand All @@ -154,7 +154,7 @@ def use_setlist(partitions):
"""
def __init__(self, client, path, set, partition_func=None,
identifier=None, time_boundary=30):
"""Create a :class:~SetPartitioner` instance
"""Create a :class:`~SetPartitioner` instance
:param client: A :class:`~kazoo.client.KazooClient` instance
:param path: The partition path to use
Expand Down

0 comments on commit 5dcc08f

Please sign in to comment.