From 8585992163092f33081ef49c539101145b573a66 Mon Sep 17 00:00:00 2001
From: Shawn Silverman <shawn@pobox.com>
Date: Tue, 3 Dec 2019 01:06:07 -0800
Subject: [PATCH] Clarifying 'Recevier::readPacket' docs to state that the
 packet stats are filled in regardless of the function's return value.

---
 src/TeensyDMX.h | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/TeensyDMX.h b/src/TeensyDMX.h
index 5d54b52..d87e9d5 100644
--- a/src/TeensyDMX.h
+++ b/src/TeensyDMX.h
@@ -292,8 +292,9 @@ class Receiver final : public TeensyDMX {
   // been stopped.
   //
   // If the optional parameter, `stats`, is set to non-NULL, then the latest
-  // packet statistics are stored in that object. The values are read atomically
-  // with the latest packet data. This is an advantage over 'packetStats()`.
+  // packet statistics are stored in that object, regardless of this function's
+  // return value. The values are read atomically with the latest packet data.
+  // This is an advantage over 'packetStats()`.
   int readPacket(uint8_t *buf, int startChannel, int len,
                  PacketStats *stats = nullptr);