Skip to content

Commit

Permalink
Document asyncio support
Browse files Browse the repository at this point in the history
Signed-off-by: Bernát Gábor <[email protected]>
  • Loading branch information
gaborbernat committed Oct 2, 2021
1 parent 856e935 commit f4b4912
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ Installation
Tutorial
--------

### Examples

A :class:`FileLock <filelock.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 <filelock.FileLock>` first:

Expand Down Expand Up @@ -123,6 +121,12 @@ The :class:`SoftFileLock <filelock.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 <https://github.com/tox-dev/py-filelock/issues/99>`_.

Contributions and issues
------------------------

Expand Down

0 comments on commit f4b4912

Please sign in to comment.