Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outdated Documentation: Async Support #368

Open
kevdog824 opened this issue Oct 7, 2024 · 0 comments
Open

Outdated Documentation: Async Support #368

kevdog824 opened this issue Oct 7, 2024 · 0 comments

Comments

@kevdog824
Copy link

Disclaimer: I have searched the project's open issues here on GitHub and did not find any related issues

Documentation provided for filelock library readthedocs page is outdated. Currently, the documentation states:

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.

The "see here" link links to #99.

However, I can see that asyncio support for the library was added in version 3.15.0 in #332. #332 includes only a single usage example but does not have extensive documentation as far as I can tell. Please update the documentation to include usage instructions and examples for async use.

If no one has capacity to help with this, I might be able to contribute at some later point.

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant