From de11875b1ec66eb22e184d8edb0249cd70ae0f72 Mon Sep 17 00:00:00 2001
From: maksimdrachov <39975120+maksimdrachov@users.noreply.github.com>
Date: Sun, 14 May 2023 10:42:29 +0300
Subject: [PATCH] Added asyncio note (#299)
---
CONTRIBUTING.rst | 14 ++++++++++++++
pycyphal/_version.py | 2 +-
2 files changed, 15 insertions(+), 1 deletion(-)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index f085b9ef..f369d17d 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -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 `_
+
+ - Asyncio API documentation:
+
+ - `Coroutines and Tasks `_
+
+ - `Queues `_
+
+ - `Event Loop `_
+
Coding conventions
------------------
diff --git a/pycyphal/_version.py b/pycyphal/_version.py
index 6b0872cb..8b0c9156 100644
--- a/pycyphal/_version.py
+++ b/pycyphal/_version.py
@@ -1 +1 @@
-__version__ = "1.15.0"
+__version__ = "1.15.1"