docs: describes the new group options

This commit is contained in:
Ilan
2015-07-18 18:50:14 +02:00
parent a5d4c5186c
commit e1d483e1c1
2 changed files with 67 additions and 10 deletions

View File

@@ -51,7 +51,7 @@ Reference
.. py:function:: schedule(func, *args, hook=None, schedule_type='O', repeats=-1, next_run=now() , **kwargs)
Creates a schedule
:param str name: A sensible name for your schedule
:param str func: the function to schedule. Dotted strings only.
:param args: arguments for the scheduled function.
:param str hook: optional result hook function. Dotted strings only.
@@ -68,6 +68,10 @@ Reference
Primary key
.. py:attribute:: name
A name for your schedule. Tasks created by this schedule will assume this as their group id.
.. py:attribute:: func
The function to be scheduled