Skip to content

Commit f4b4912

Browse files
committed
Document asyncio support
Signed-off-by: Bernát Gábor <[email protected]>
1 parent 856e935 commit f4b4912

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/index.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ Installation
4141
Tutorial
4242
--------
4343

44-
### Examples
45-
4644
A :class:`FileLock <filelock.FileLock>` is used to indicate another process of your application that a resource or
4745
working directory is currently used. To do so, create a :class:`FileLock <filelock.FileLock>` first:
4846

@@ -123,6 +121,12 @@ The :class:`SoftFileLock <filelock.SoftFileLock>` only watches the existence of
123121
portable, but also more prone to dead locks if the application crashes. You can simply delete the lock file in such
124122
cases.
125123

124+
Asyncio support
125+
---------------
126+
127+
This library currently does not support asyncio. We'd recommend adding an asyncio variant though if someone can make a
128+
pull request for it, `see here <https://github.com/tox-dev/py-filelock/issues/99>`_.
129+
126130
Contributions and issues
127131
------------------------
128132

0 commit comments

Comments
 (0)