sys/isrpipe: document worst-case wait time

basilfx · basilfx · commit 4e8de818501a · 2026-06-17T00:33:43.000+02:00
diff --git a/sys/include/isrpipe/read_timeout.h b/sys/include/isrpipe/read_timeout.h
@@ -52,7 +52,8 @@ int isrpipe_read_timeout(isrpipe_t *isrpipe, uint8_t *buf, size_t count, uint32_
  * timeout or when @p count bytes have been received.
  *
  * A timeout only occurs if no data is received within @p timeout microseconds.
- * Each time a byte or burst of bytes is received, the timeout is reset.
+ * Each time a byte or burst of bytes is received, the timeout is reset. This
+ * means the worst-case total wait is @p count × @p timeout microseconds.
  *
  * @note If a timeout occurs, some bytes may have been read out of the pipe and
  * placed into @p buf.

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,8 @@ int isrpipe_read_timeout(isrpipe_t isrpipe, uint8_t buf, size_t count, uint32_`
`52`	`52`	`* timeout or when @p count bytes have been received.`
`53`	`53`	`*`
`54`	`54`	`* A timeout only occurs if no data is received within @p timeout microseconds.`
`55`		`- * Each time a byte or burst of bytes is received, the timeout is reset.`
	`55`	`+ * Each time a byte or burst of bytes is received, the timeout is reset. This`
	`56`	`+ * means the worst-case total wait is @p count × @p timeout microseconds.`
`56`	`57`	`*`
`57`	`58`	`* @note If a timeout occurs, some bytes may have been read out of the pipe and`
`58`	`59`	`* placed into @p buf.`