Adds croniter install note

Koed00 · Jul 2, 2020 · 1fe17f8 · 1fe17f8
1 parent f847974
commit 1fe17f8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/install.rst b/docs/install.rst
@@ -88,6 +88,9 @@ Optional
 
 
 
+
+.. _croniter_package:
+
 - `Croniter <https://github.com/kiorky/croniter>`__ is an optional package that is used to parse cron expressions for the scheduler::
 
     $ pip install croniter

diff --git a/docs/schedules.rst b/docs/schedules.rst
@@ -95,6 +95,10 @@ Or you can make a wrapper function which you can then schedule in Django Q:
 
 Check out the :ref:`shell` examples if you want to schedule regular shell commands
 
+.. note::
+
+   Schedules needs the optional :ref:`Croniter<croniter_package>` package installed to parse cron expressions.
+
 Reference
 ---------
 
@@ -223,6 +227,6 @@ Reference
 
     .. py:attribute:: CRON
 
-    `'C'` uses the optional `croniter` package to determine a schedule based a cron expression.
+    `'C'` uses the optional `croniter` package to determine a schedule based on a cron expression.