From f4b491255d519c779f6268122f6cf29badc4e409 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bern=C3=A1t=20G=C3=A1bor?= Date: Sat, 2 Oct 2021 22:37:24 +0100 Subject: [PATCH] Document asyncio support MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Bernát Gábor --- docs/index.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index a7bdbaa..540e807 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -41,8 +41,6 @@ Installation Tutorial -------- -### Examples - A :class:`FileLock ` is used to indicate another process of your application that a resource or working directory is currently used. To do so, create a :class:`FileLock ` first: @@ -123,6 +121,12 @@ The :class:`SoftFileLock ` only watches the existence of portable, but also more prone to dead locks if the application crashes. You can simply delete the lock file in such cases. +Asyncio support +--------------- + +This library currently does not support asyncio. We'd recommend adding an asyncio variant though if someone can make a +pull request for it, `see here `_. + Contributions and issues ------------------------