From 63fa8ca4bdb30274a737c276cba6b9a1ad6c1e0f Mon Sep 17 00:00:00 2001
From: Michael Harwerth <miq1@gmx.de>
Date: Fri, 26 Jan 2024 16:30:05 +0100
Subject: [PATCH] Add ``clearQueue()`` description

---
 _docs/modbusclient/commonapi.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/_docs/modbusclient/commonapi.md b/_docs/modbusclient/commonapi.md
index 6b7c9dc..0b07188 100644
--- a/_docs/modbusclient/commonapi.md
+++ b/_docs/modbusclient/commonapi.md
@@ -82,6 +82,10 @@ Each error response received will be counted. The `getErrorCount()` method will
 ## `void resetCounts()`
 The internal counters for both messages and errors can be set to zero using this call.
 
+## `void clearQueue()`
+This method will immediately remove all pending requests from the queue - in case of an emergency or if a general cleanup is desired. 
+If requests have been sent already, the responses to those will be dropped (with a warning log message).
+
 ## Setting up requests
 
 ### Asynchronous requests (non-blocking)