diff --git a/README.rst b/README.rst index e056a880..9d501a5b 100644 --- a/README.rst +++ b/README.rst @@ -14,7 +14,7 @@ pytest-asyncio :alt: Matrix chat room: #pytest-asyncio :target: https://matrix.to/#/#pytest-asyncio:matrix.org -`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: @@ -25,7 +25,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 `_. +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 `__ diff --git a/pyproject.toml b/pyproject.toml index 10637e76..7580def3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -54,7 +54,7 @@ optional-dependencies.testing = [ "hypothesis>=5.7.1", ] urls."Bug Tracker" = "https://github.com/pytest-dev/pytest-asyncio/issues" -urls.Changelog = "https://pytest-asyncio.readthedocs.io/en/latest/reference/changelog.html" +urls.Changelog = "https://pytest-asyncio.readthedocs.io/en/stable/reference/changelog.html" urls.Documentation = "https://pytest-asyncio.readthedocs.io" urls.Homepage = "https://github.com/pytest-dev/pytest-asyncio" urls."Source Code" = "https://github.com/pytest-dev/pytest-asyncio"