From 8fbb12eddfbfcbf37db4fd7e4be10a1f8bb7d991 Mon Sep 17 00:00:00 2001
From: JamesWrigley <james@puiterwijk.org>
Date: Mon, 11 Dec 2023 18:42:37 +0100
Subject: [PATCH] Document that ssh_channel_read_nonblocking() will trigger
 callbacks

Signed-off-by: James Wrigley <james@puiterwijk.org>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>
Reviewed-by: Norbert Pocs <norbertpocs0@gmail.com>
---
 src/channels.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/channels.c b/src/channels.c
index fe040c1f..4e3de321 100644
--- a/src/channels.c
+++ b/src/channels.c
@@ -3140,7 +3140,7 @@ int ssh_channel_read_timeout(ssh_channel channel,
  * @brief Do a nonblocking read on the channel.
  *
  * A nonblocking read on the specified channel. it will return <= count bytes of
- * data read atomically.
+ * data read atomically. It will also trigger any callbacks set on the channel.
  *
  * @param[in]  channel  The channel to read from.
  *