From 371e1f3c5e079aa51b9cfe3f1e9017234e2f42fc Mon Sep 17 00:00:00 2001 From: Rob Calon <31725587+robcalon@users.noreply.github.com> Date: Tue, 27 Dec 2022 17:36:10 +0100 Subject: [PATCH] update docstring --- dsmr_parser/clients/serial_.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/dsmr_parser/clients/serial_.py b/dsmr_parser/clients/serial_.py index d8bc529..f6e892f 100644 --- a/dsmr_parser/clients/serial_.py +++ b/dsmr_parser/clients/serial_.py @@ -98,7 +98,11 @@ class AsyncSerialReader(SerialReader): async def read_as_object(self, queue): """ - Read complete DSMR telegram's from the serial interface and return a Telegram object. + Read complete DSMR telegram's from the serial interface + and return a Telegram object. + + Instead of being a generator, Telegram objects are pushed + to provided queue for asynchronous processing. :rtype: None """