From: Jacob Lifshay <programmerjake@gmail.com>
Date: Thu, 4 Aug 2022 07:04:45 +0000 (-0700)
Subject: add important note to byte_reverse's docs
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=d2dab1069c06c85d2e337f72c94c0426d493f3ac;p=nmutil.git

add important note to byte_reverse's docs
---

diff --git a/src/nmutil/byterev.py b/src/nmutil/byterev.py
index b0c9daf..a7f0a68 100644
--- a/src/nmutil/byterev.py
+++ b/src/nmutil/byterev.py
@@ -15,6 +15,8 @@ def byte_reverse(m, name, data, length):
 
     nmigen Signal.word_select may only take a fixed length.  we need
     bigendian byte-reverse, half-word reverse, word and dword reverse.
+
+    This only outputs the first `length` bytes, higher bytes are zeroed.
     """
     comb = m.d.comb
     data_r = Signal.like(data, name=name)