Browse Source

Fixes documentation rst issues

Ask Solem 13 years ago
parent
commit
00c5903293
4 changed files with 19 additions and 18 deletions
  1. 2 2
      Changelog
  2. 1 1
      celery/concurrency/base.py
  3. 7 5
      docs/configuration.rst
  4. 9 10
      docs/userguide/workers.rst

+ 2 - 2
Changelog

@@ -17,8 +17,8 @@ See :ref:`whatsnew-2.5`.
 
 We decided to do things differently this time, considering the changelog
 is very long we're going to have separate documents for major version changes,
-called "what's new" documents.  Bugfix releases will be located in the
-changelog still.
+called "what's new" documents.  Bugfix releases will still be located in the
+changelog.
 
 .. _version-2.4.5:
 

+ 1 - 1
celery/concurrency/base.py

@@ -30,7 +30,7 @@ class BasePool(object):
 
     #: set to true if pool supports rate limits.
     #: (this is here for gevent, which currently does not implement
-    #:  the necessary timers).
+    #: the necessary timers).
     rlimit_safe = True
 
     #: set to true if pool requires the use of a mediator

+ 7 - 5
docs/configuration.rst

@@ -584,15 +584,17 @@ CASSANDRA_WRITE_CONSISTENCY
 
 The write consistency used. Values can be `"ONE"`, `"QUORUM"` or `"ALL"`.
 
-.. setting:: CASSANDRA_WRITE_CONSISTENCY
+.. setting:: CASSANDRA_DETAILED_MODE
 
 CASSANDRA_DETAILED_MODE
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Enable or disable detailed mode. Default is `"False"`.
-This mode allows to use the power of Cassandra wide columns to store all states for a task as a wide column, instead of only the last one.
+This mode allows to use the power of Cassandra wide columns to
+store all states for a task as a wide column, instead of only the last one.
 
-To use this mode, you need to configure your ColumnFamily to use the `TimeUUID` type as a comparator::
+To use this mode, you need to configure your ColumnFamily to
+use the `TimeUUID` type as a comparator::
 
     create column family task_results with comparator = TimeUUIDType;
 
@@ -1434,7 +1436,7 @@ CELERY_SECURITY_CERT_STORE
 .. versionadded:: 2.5
 
 The directory containing X.509 certificates used for
-:ref:`message signing`.  Can be a glob with wildcards,
+:ref:`message-signing`.  Can be a glob with wildcards,
 (for example :file:`/etc/certs/*.pem`).
 
 .. _conf-custom-components:

+ 9 - 10
docs/userguide/workers.rst

@@ -387,22 +387,21 @@ If you want to reload all modules you can use:
 
 `imports` argument is a list of modules to modify. `reload_modules`
 specifies whether to reload modules if they are previously imported.
-By default `reload_modules` is `False`. `pool_restart` command uses the
-`reload`_ built in function to reload modules, but you can provide custom
-reloader as well.
+By default `reload_modules` is `False`. The `pool_restart` command uses the
+Python :func:`reload` function to reload modules, or you can provide
+your own custom reloader.
 
 .. note::
 
-Module reloading comes with some caveats that are documented in :fun:`reload`.
-Make sure your modules are suitable for reloading.
+    Module reloading comes with caveats that are documented in :func:`reload`.
+    Please read this documentation and make sure your modules are suitable
+    for reloading.
 
 .. seealso::
 
-http://pyunit.sourceforge.net/notes/reloading.html
-
-http://www.indelible.org/ink/python-reloading/
-
-http://docs.python.org/library/functions.html#reload
+    - http://pyunit.sourceforge.net/notes/reloading.html
+    - http://www.indelible.org/ink/python-reloading/
+    - http://docs.python.org/library/functions.html#reload
 
 .. _worker-custom-control-commands: