Skip to content

Commit

Permalink
Added asyncio note (#299)
Browse files Browse the repository at this point in the history
  • Loading branch information
maksimdrachov authored May 14, 2023
1 parent 4f56e65 commit de11875
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,20 @@ There are two kinds of 3rd-party dependencies used by this library:
instead, they are registered as *package extras*. Please read the detailed documentation and the applicable
conventions in the user documentation and in ``setup.cfg``.

.. tip:: asyncio

The pycyphal code relies pretty heavily on asyncio. If you're not familiar with this library, it is recommended to take a look at the following links:

- `A general introduction <https://realpython.com/async-io-python/>`_

- Asyncio API documentation:

- `Coroutines and Tasks <https://docs.python.org/3/library/asyncio-task.html>`_

- `Queues <https://docs.python.org/3/library/asyncio-queue.html>`_

- `Event Loop <https://docs.python.org/3/library/asyncio-eventloop.html>`_


Coding conventions
------------------
Expand Down
2 changes: 1 addition & 1 deletion pycyphal/_version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.15.0"
__version__ = "1.15.1"

0 comments on commit de11875

Please sign in to comment.