diff --git a/README.rst b/README.rst index 81984e88..9eba8d23 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,7 @@ pytest-asyncio .. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black -pytest-asyncio is a `pytest `_ plugin. It facilitates testing of code that uses the `asyncio `_ library. +`pytest-asyncio `_ is a `pytest `_ plugin. It facilitates testing of code that uses the `asyncio `_ library. Specifically, pytest-asyncio provides support for coroutines as test functions. This allows users to *await* code inside their tests. For example, the following code is executed as a test item by pytest: @@ -24,6 +24,7 @@ Specifically, pytest-asyncio provides support for coroutines as test functions. res = await library.do_something() assert b"expected result" == res +More details can be found in the `documentation `_. Note that test classes subclassing the standard `unittest `__ library are not supported. Users are advised to use `unittest.IsolatedAsyncioTestCase `__