Browse Source

First set of minor doco change suggestions.

Rachel Willmer 12 years ago
parent
commit
c85d3179c9

+ 1 - 1
docs/getting-started/brokers/beanstalk.rst

@@ -27,7 +27,7 @@ Configuration
 =============
 =============
 
 
 Configuration is easy, set the transport, and configure the location of
 Configuration is easy, set the transport, and configure the location of
-your CouchDB database::
+your Beanstalk database::
 
 
     BROKER_URL = 'beanstalk://localhost:11300'
     BROKER_URL = 'beanstalk://localhost:11300'
 
 

+ 2 - 0
docs/getting-started/brokers/couchdb.rst

@@ -53,3 +53,5 @@ Limitations
 The Beanstalk message transport does not currently support:
 The Beanstalk message transport does not currently support:
 
 
     * Remote control commands (celeryctl, broadcast)
     * Remote control commands (celeryctl, broadcast)
+
+[Q: What's Beanstalk got to do with CouchDB? what are the CouchDB limitations?]

+ 2 - 2
docs/getting-started/brokers/redis.rst

@@ -11,7 +11,7 @@ Installation
 
 
 For the Redis support you have to install additional dependencies.
 For the Redis support you have to install additional dependencies.
 You can install both Celery and these dependencies in one go using
 You can install both Celery and these dependencies in one go using
-ehter the `celery-with-redis`_, or the `django-celery-with-redis` bundles::
+either the `celery-with-redis`_, or the `django-celery-with-redis` bundles::
 
 
     $ pip install -U celery-with-redis
     $ pip install -U celery-with-redis
 
 
@@ -44,5 +44,5 @@ you should configure these settings::
 
 
     CELERY_RESULT_BACKEND = 'redis://localhost:6379/0'
     CELERY_RESULT_BACKEND = 'redis://localhost:6379/0'
 
 
-For a complete list of options supported by the Redis result backend see
+For a complete list of options supported by the Redis result backend, see
 :ref:`conf-redis-result-backend`
 :ref:`conf-redis-result-backend`

+ 2 - 2
docs/getting-started/first-steps-with-celery.rst

@@ -2,7 +2,7 @@
 .. _first-steps:
 .. _first-steps:
 
 
 ========================
 ========================
- First steps with Celery
+ First Steps with Celery
 ========================
 ========================
 
 
 Celery is a task queue with batteries included.
 Celery is a task queue with batteries included.
@@ -23,7 +23,7 @@ You will learn about;
 
 
 Celery may seem daunting at first - but don't worry - this tutorial
 Celery may seem daunting at first - but don't worry - this tutorial
 will get you started in no time. It is deliberately kept simple, so
 will get you started in no time. It is deliberately kept simple, so
-to not confuse you with advances features.
+to not confuse you with advanced features.
 After you have finished this tutorial
 After you have finished this tutorial
 it's a good idea to browse the rest of the documentation,
 it's a good idea to browse the rest of the documentation,
 for example the :ref:`next-steps` tutorial, which will
 for example the :ref:`next-steps` tutorial, which will

+ 32 - 14
docs/getting-started/intro.rst

@@ -39,7 +39,8 @@ Celery is…
 
 
     - **Simple**
     - **Simple**
 
 
-        Celery is easy to use and maintain, and does *not need configuration files*
+        Celery is easy to use and maintain, and does *not need configuration files*.
+
         It has an active, friendly community you can talk to for support,
         It has an active, friendly community you can talk to for support,
         including a :ref:`mailing-list <mailing-list>` and and :ref:`IRC
         including a :ref:`mailing-list <mailing-list>` and and :ref:`IRC
         channel <irc-channel>`.
         channel <irc-channel>`.
@@ -62,6 +63,8 @@ Celery is…
         of connection loss or failure, and some brokers support
         of connection loss or failure, and some brokers support
         HA in way of *Master/Master* or -- *Master/Slave* replication.
         HA in way of *Master/Master* or -- *Master/Slave* replication.
 
 
+[Q: What's the purpose of the '--' before Master/Slave?]
+
     - **Fast**
     - **Fast**
 
 
         A single Celery process can process millions of tasks a minute,
         A single Celery process can process millions of tasks a minute,
@@ -82,10 +85,15 @@ Celery is…
 
 
         - **Brokers**
         - **Brokers**
 
 
-            - :ref:`RabbitMQ <broker-rabbitmq>`, :ref:`Redis <broker-redis>`,
-            - :ref:`MongoDB <broker-mongodb>`, :ref:`Beanstalk <broker-beanstalk>`,
-            - :ref:`CouchDB <broker-couchdb>`, :ref:`SQLAlchemy <broker-sqlalchemy>`,
-            - :ref:`Django ORM <broker-django>`, :ref:`Amazon SQS <broker-sqs>`, and more…
+            - :ref:`RabbitMQ <broker-rabbitmq>`
+            - :ref:`Redis <broker-redis>`,
+            - :ref:`MongoDB <broker-mongodb>` 
+            - :ref:`Beanstalk <broker-beanstalk>`
+            - :ref:`CouchDB <broker-couchdb>` 
+            - :ref:`SQLAlchemy <broker-sqlalchemy>`
+            - :ref:`Django ORM <broker-django>` 
+            - :ref:`Amazon SQS <broker-sqs>`
+            - and more…
 
 
         - **Concurrency**
         - **Concurrency**
 
 
@@ -96,17 +104,26 @@ Celery is…
 
 
         - **Result Stores**
         - **Result Stores**
 
 
-            - AMQP, Redis
-            - memcached, MongoDB,
-            - SQLAlchemy/Django ORM,
-            - Apache Cassandra.
+            - AMQP 
+            - Redis
+            - memcached 
+            - MongoDB
+            - SQLAlchemy
+            - Django ORM
+            - Apache Cassandra
 
 
-        - **Serialization & Compression**
+        - **Serialization**
 
 
             - *pickle*, *json*, *yaml*, *msgpack*.
             - *pickle*, *json*, *yaml*, *msgpack*.
+            - Fine-grained serialization settings.
+
+        - **Compression**
+
             - *zlib*, *bzip2*, or uncompressed.
             - *zlib*, *bzip2*, or uncompressed.
+
+        - **Crypto**
+
             - Cryptographic message signing.
             - Cryptographic message signing.
-            - Fine-grained serialization settings.
 
 
 
 
 
 
@@ -117,7 +134,7 @@ Celery is…
 
 
         - **Monitoring**
         - **Monitoring**
 
 
-            The stream of monitoring events emit by the worker are used
+            The stream of monitoring events emitted by the worker are used
             by built-in and external tools to tell you what your cluster
             by built-in and external tools to tell you what your cluster
             is doing in real-time.
             is doing in real-time.
 
 
@@ -151,7 +168,7 @@ Celery is…
 
 
             The :option:`--maxtasksperchild` option is used for user tasks
             The :option:`--maxtasksperchild` option is used for user tasks
             leaking resources, like memory or file descriptors, that
             leaking resources, like memory or file descriptors, that
-            are out simply out of your control.
+            are simply out of your control.
 
 
             :ref:`Read more… <worker-maxtasksperchild>`.
             :ref:`Read more… <worker-maxtasksperchild>`.
 
 
@@ -159,7 +176,7 @@ Celery is…
 
 
             Each worker component can be customized, and additional components
             Each worker component can be customized, and additional components
             can be defined by the user.  The worker is built up using "boot steps" — a
             can be defined by the user.  The worker is built up using "boot steps" — a
-            dependency graph enabling fine grained control of the workers
+            dependency graph enabling fine grained control of the worker's
             internals.
             internals.
 
 
 .. _`Eventlet`: http://eventlet.net/
 .. _`Eventlet`: http://eventlet.net/
@@ -197,6 +214,7 @@ Celery is…
         - :ref:`get a list of people and companies using Celery <res-using-celery>`
         - :ref:`get a list of people and companies using Celery <res-using-celery>`
         - :ref:`write my own remote control command <worker-custom-control-commands>`
         - :ref:`write my own remote control command <worker-custom-control-commands>`
         - change worker queues at runtime
         - change worker queues at runtime
+[Q: is there a reference for this?]
 
 
 .. topic:: Jump to ⟶
 .. topic:: Jump to ⟶
 
 

+ 6 - 2
docs/includes/introduction.txt

@@ -16,7 +16,7 @@ Synopsis
 ========
 ========
 
 
 Celery is an open source asynchronous task queue/job queue based on
 Celery is an open source asynchronous task queue/job queue based on
-distributed message passing.  Focused on real-time operation,
+distributed message passing. It is focused on real-time operation,
 but supports scheduling as well.
 but supports scheduling as well.
 
 
 The execution units, called tasks, are executed concurrently on one or
 The execution units, called tasks, are executed concurrently on one or
@@ -95,6 +95,10 @@ The broker delivers tasks to the worker nodes.
 A worker node is a networked machine running `celeryd`.  This can be one or
 A worker node is a networked machine running `celeryd`.  This can be one or
 more machines depending on the workload.
 more machines depending on the workload.
 
 
+[Q: Do you mean 'there can be many worker nodes' or 'A worker node can
+be more than one machine'? I think the former...]
+
+
 The result of the task can be stored for later retrieval (called its
 The result of the task can be stored for later retrieval (called its
 "tombstone").
 "tombstone").
 
 
@@ -104,7 +108,7 @@ Example
 =======
 =======
 
 
 You probably want to see some code by now, so here's an example task
 You probably want to see some code by now, so here's an example task
-adding two numbers:
+which adds two numbers:
 
 
 .. code-block:: python
 .. code-block:: python