From b9b4a275dcbad22672e999812543d51f09a10835 Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Wed, 6 Sep 2023 08:14:38 -0700 Subject: [PATCH] Re-add AsyncMultiQueue cross-reference Replace the mention of the clear method with a proper cross-reference now that documentation generation is working correctly. --- docs/user-guide/asyncio-queue.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/asyncio-queue.rst b/docs/user-guide/asyncio-queue.rst index 0f19f9c6..3c9aa611 100644 --- a/docs/user-guide/asyncio-queue.rst +++ b/docs/user-guide/asyncio-queue.rst @@ -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.