Browse Source

Docs: Fix rst errors

Ask Solem 14 years ago
parent
commit
6977271fae

+ 1 - 1
Changelog

@@ -868,7 +868,7 @@ News
 
     >>> crontab(minute="*/30", hour="8-17,1-2", day_of_week="thu-fri")
 
-  See :doc:`getting-started/periodic-tasks`.
+  See :doc:`userguide/periodic-tasks`.
 
 * celeryd: Now waits for available pool processes before applying new
   tasks to the pool.

+ 3 - 4
celery/utils/timeutils.py

@@ -59,11 +59,10 @@ def delta_resolution(dt, delta):
 def remaining(start, ends_in, now=None, relative=True):
     """Calculate the remaining time for a start date and a timedelta.
 
-    E.g. "how many seconds left for 30 seconds after ``start``?"
-
-    :param start: Start :class:`datetime.datetime`.
-    :param ends_in: The end delta as a :class:`datetime.timedelta`.
+    e.g. "how many seconds left for 30 seconds after start?"
 
+    :param start: Start :class:`~datetime.datetime`.
+    :param ends_in: The end delta as a :class:`~datetime.timedelta`.
     :keyword relative: If set to ``False``, the end time will be calculated
         using :func:`delta_resolution` (i.e. rounded to the resolution
           of ``ends_in``).

+ 0 - 0
docs/homepage/examplerun.rst → docs/homepage/examplerun.txt


+ 0 - 0
docs/homepage/exampletask.rst → docs/homepage/exampletask.txt


+ 5 - 5
docs/internals/reference/celery.events.snapshot.rst

@@ -1,11 +1,11 @@
-=========================================
- Event Snapshots - celery.event.snapshot
-=========================================
+==========================================
+ Event Snapshots - celery.events.snapshot
+==========================================
 
 .. contents::
     :local:
-.. currentmodule:: celery.event.snapshot
+.. currentmodule:: celery.events.snapshot
 
-.. automodule:: celery.event.snapshot
+.. automodule:: celery.events.snapshot
     :members:
     :undoc-members:

+ 1 - 1
docs/userguide/periodic-tasks.rst

@@ -24,7 +24,7 @@ Scheduling Tasks
 ================
 
 To schedule a task periodically you have to add an entry to the
-``CELERYBEAT_SCHEDULE`` setting::
+``CELERYBEAT_SCHEDULE`` setting:
 
 .. code-block:: python