Skip to content

Commit 37aec4d

Browse files
authored
Add documentation link after migration to docs (#496)
The README doesn't provide an easy way to find the docs :)
1 parent d697088 commit 37aec4d

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pytest-asyncio
1313
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
1414
:target: https://github.com/ambv/black
1515

16-
pytest-asyncio is a `pytest <https://docs.pytest.org/en/latest/contents.html>`_ plugin. It facilitates testing of code that uses the `asyncio <https://docs.python.org/3/library/asyncio.html>`_ library.
16+
`pytest-asyncio <https://pytest-asyncio.readthedocs.io/en/latest/>`_ is a `pytest <https://docs.pytest.org/en/latest/contents.html>`_ plugin. It facilitates testing of code that uses the `asyncio <https://docs.python.org/3/library/asyncio.html>`_ library.
1717

1818
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:
1919

@@ -24,6 +24,7 @@ Specifically, pytest-asyncio provides support for coroutines as test functions.
2424
res = await library.do_something()
2525
assert b"expected result" == res
2626
27+
More details can be found in the `documentation <https://pytest-asyncio.readthedocs.io/en/latest/>`_.
2728

2829
Note that test classes subclassing the standard `unittest <https://docs.python.org/3/library/unittest.html>`__ library are not supported. Users
2930
are advised to use `unittest.IsolatedAsyncioTestCase <https://docs.python.org/3/library/unittest.html#unittest.IsolatedAsyncioTestCase>`__

0 commit comments

Comments
 (0)