Skip to content

Commit

Permalink
doc: minor improvements of Cookbook and Reference doc pages (#570)
Browse files Browse the repository at this point in the history
  • Loading branch information
jenstroeger authored Aug 22, 2023
1 parent 7434977 commit 57b605b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/source/cookbook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ Dramatiq has built-in support for a couple high-level composition
constructs. You can use these to combine generalized tasks that don't
know about one another into complex workflows.

In order to take advantage of group and pipeline result management,
you need to enable result storage and your actors need to store
results. Check out the `Results`_ section for more information on
result storage.
In order to take advantage of group and pipeline result management
or to wait for a group or pipeline to finish, you need to enable
result storage and your actors need to store results. Check out the
`Results`_ section for more information on result storage.

Groups
^^^^^^
Expand Down Expand Up @@ -340,7 +340,8 @@ You can use Dramatiq's |RateLimiters| to constrain actor concurrency.
Whenever two ``one_at_a_time`` actors run at the same time, one of
them will be retried with exponential backoff. This works by raising
an exception and relying on the built-in Retries middleware to do the
an exception and relying on the built-in
:class:`Retries<dramatiq.middleware.Retries>` middleware to do the
work of re-enqueueing the task.

If you want rate limiters not to raise an exception when they can't be
Expand Down
2 changes: 2 additions & 0 deletions docs/source/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ The following middleware are all enabled by default.
.. autoclass:: dramatiq.middleware.AsyncIO
.. autoclass:: dramatiq.middleware.Callbacks
.. autoclass:: dramatiq.middleware.CurrentMessage
:members:
:member-order: bysource
.. autoclass:: dramatiq.middleware.Pipelines
.. autoclass:: dramatiq.middleware.Prometheus
.. autoclass:: dramatiq.middleware.Retries
Expand Down

0 comments on commit 57b605b

Please sign in to comment.