diff --git a/docs/install.rst b/docs/install.rst index 67f8279..5f2ff5a 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -59,7 +59,7 @@ This can be useful if you have several projects using the same Redis server. workers ~~~~~~~ -The number of workers to use in the cluster. Defaults to CPU count of the current host, but can be set to a custom number. +The number of workers to use in the cluster. Defaults to CPU count of the current host, but can be set to a custom number. [#f1]_ recycle ~~~~~~~ @@ -232,4 +232,8 @@ Optional $ pip install hiredis -.. py:module:: django_q \ No newline at end of file +.. py:module:: django_q + +.. rubric:: Footnotes + +.. [#f1] Uses :func:`multiprocessing.cpu_count()` which can fail on some platforms. If so , please set the worker count in the configuration manually or install :ref:`psutil` to provide an alternative cpu count method. diff --git a/docs/monitor.rst b/docs/monitor.rst index 5035ab8..7e99a4a 100644 --- a/docs/monitor.rst +++ b/docs/monitor.rst @@ -152,5 +152,6 @@ Reference Returns a list of :class:`Stat` objects for all active clusters. Takes an optional redis connection. +.. rubric:: Footnotes .. [#f1] Uses :meth:`multiprocessing.Queue.qsize()` which is not implemented on OS X.