Skip to content

Commit

Permalink
Clarify docs to link to Huey's parameter list.
Browse files Browse the repository at this point in the history
Fixes #496
  • Loading branch information
coleifer committed Feb 24, 2020
1 parent 8cb6f89 commit 48ed3ff
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,16 @@ The API documentation will follow the structure of the huey ``api.py`` module.
Huey types
----------

Implementations of :py:class:`Huey` which handle task and result persistence.

.. note::
See the documentation for :py:class:`Huey` for the list of initialization
parameters common to all Huey implementations.

.. py:class:: RedisHuey
Huey that utilizes `redis <https://redis.io/>`_ for queue and result
storage. Requires `redis-py <https://github.com/andymccurdy/redis-py>`_.
:py:class:`Huey` that utilizes `redis <https://redis.io/>`_ for queue and
result storage. Requires `redis-py <https://github.com/andymccurdy/redis-py>`_.

Commonly-used keyword arguments for storage configuration:

Expand Down Expand Up @@ -46,8 +52,8 @@ Huey types

.. py:class:: PriorityRedisHuey
Huey that utilizes `redis <https://redis.io/>`_ for queue and result
storage. Requires `redis-py <https://github.com/andymccurdy/redis-py>`_.
:py:class:`Huey` that utilizes `redis <https://redis.io/>`_ for queue and
result storage. Requires `redis-py <https://github.com/andymccurdy/redis-py>`_.
Accepts the same arguments as :py:class:`RedisHuey`.

PriorityRedisHuey supports :ref:`task priorities <priority>`, and requires
Expand Down Expand Up @@ -91,8 +97,8 @@ Huey types

.. py:class:: SqliteHuey
Huey that utilizes sqlite3 for queue and result storage. Only requirement
is the standard library ``sqlite3`` module.
:py:class:`Huey` that utilizes sqlite3 for queue and result storage. Only
requirement is the standard library ``sqlite3`` module.

Commonly-used keyword arguments:

Expand All @@ -107,13 +113,14 @@ Huey types

.. py:class:: MemoryHuey
Huey that uses in-memory storage. Only should be used when testing or when
using ``immediate`` mode. MemoryHuey fully supports task priorities.
:py:class:`Huey` that uses in-memory storage. Only should be used when
testing or when using ``immediate`` mode. MemoryHuey fully supports task
priorities.

.. py:class:: FileHuey
Huey that uses the file-system for storage. Should not be used in
high-throughput, highly-concurrent environments, as the
:py:class:`Huey` that uses the file-system for storage. Should not be used
in high-throughput, highly-concurrent environments, as the
:py:class:`FileStorage` utilizes exclusive locks around all file-system
operations.

Expand Down

0 comments on commit 48ed3ff

Please sign in to comment.