Skip to content

Commit eeda186

Browse files
juannyGOmer Katz
authored andcommitted
Minor documentation tweaks for broken links (celery#4770)
* Minor doc tweaks to broken links Some internal documentation link references were broken. For example, the `app` parameter in [celery.schedules documentation](http://docs.celeryproject.org/en/master/reference/celery.schedules.html#celery-schedules) links to ~@celery, which in the browser attempts to open an email client. Alternatively, the [tasks userguide](http://docs.celeryproject.org/en/master/userguide/tasks.html#automatic-retry-for-known-exceptions) was also suffering from a similar reference error, but in this case, produces no hyperlink. * Update two more broken hyperlink instances * Internal `AsyncResult` argument parameter * `datetime` reference in celery.schedules nowfun paramater description
1 parent 6fd0d35 commit eeda186

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

celery/app/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -699,7 +699,7 @@ def send_task(self, name, args=None, kwargs=None, countdown=None,
699699
700700
Arguments:
701701
name (str): Name of task to call (e.g., `"tasks.add"`).
702-
result_cls (~@AsyncResult): Specify custom result class.
702+
result_cls (AsyncResult): Specify custom result class.
703703
"""
704704
parent = have_parent = None
705705
amqp = self.amqp

celery/app/task.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -471,10 +471,10 @@ def apply_async(self, args=None, kwargs=None, task_id=None, producer=None,
471471
:func:`kombu.compression.register`.
472472
Defaults to the :setting:`task_compression` setting.
473473
474-
link (~@Signature): A single, or a list of tasks signatures
474+
link (Signature): A single, or a list of tasks signatures
475475
to apply if the task returns successfully.
476476
477-
link_error (~@Signature): A single, or a list of task signatures
477+
link_error (Signature): A single, or a list of task signatures
478478
to apply if an error occurs while executing the task.
479479
480480
producer (kombu.Producer): custom producer to use when publishing

celery/bin/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ class Command(object):
144144
"""Base class for command-line applications.
145145
146146
Arguments:
147-
app (~@Celery): The app to use.
147+
app (Celery): The app to use.
148148
get_app (Callable): Fucntion returning the current app
149149
when no app provided.
150150
"""

celery/schedules.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ class schedule(BaseSchedule):
113113
relative (bool): If set to True the run time will be rounded to the
114114
resolution of the interval.
115115
nowfun (Callable): Function returning the current date and time
116-
(class:`~datetime.datetime`).
117-
app (~@Celery): Celery app instance.
116+
(:class:`~datetime.datetime`).
117+
app (Celery): Celery app instance.
118118
"""
119119

120120
relative = False
@@ -689,7 +689,7 @@ class solar(BaseSchedule):
689689
lon (int): The longitude of the observer.
690690
nowfun (Callable): Function returning the current date and time
691691
as a class:`~datetime.datetime`.
692-
app (~@Celery): Celery app instance.
692+
app (Celery): Celery app instance.
693693
"""
694694

695695
_all_events = {

docs/userguide/tasks.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ Sometimes you just want to retry a task whenever a particular exception
707707
is raised.
708708

709709
Fortunately, you can tell Celery to automatically retry a task using
710-
`autoretry_for` argument in `[email protected]` decorator:
710+
`autoretry_for` argument in the :meth:`[email protected]` decorator:
711711

712712
.. code-block:: python
713713
@@ -717,8 +717,8 @@ Fortunately, you can tell Celery to automatically retry a task using
717717
def refresh_timeline(user):
718718
return twitter.refresh_timeline(user)
719719
720-
If you want to specify custom arguments for internal `[email protected]`
721-
call, pass `retry_kwargs` argument to `[email protected]` decorator:
720+
If you want to specify custom arguments for an internal :meth:`[email protected]`
721+
call, pass `retry_kwargs` argument to :meth:`[email protected]` decorator:
722722

723723
.. code-block:: python
724724

0 commit comments

Comments
 (0)