Skip to content

Commit

Permalink
Re-add AsyncMultiQueue cross-reference
Browse files Browse the repository at this point in the history
Replace the mention of the clear method with a proper cross-reference
now that documentation generation is working correctly.
  • Loading branch information
rra committed Sep 6, 2023
1 parent a617764 commit b9b4a27
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/user-guide/asyncio-queue.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ A typical reader looks like this:
async for item in queue:
await do_something(item)
This iterates over the full contents of the queue until ``clear`` is called by the writer.
This iterates over the full contents of the queue until `~safir.asyncio.AsyncMultiQueue.clear` is called by the writer.

Readers can also start at any position and specify a timeout.
The timeout, if given, is the total length of time the iterator is allowed to run, not the time to wait for the next element.
Expand Down

0 comments on commit b9b4a27

Please sign in to comment.