From: Catherine <whitequark@whitequark.org>
Date: Mon, 13 Dec 2021 09:53:29 +0000 (+0000)
Subject: lib.fifo: clarify AsyncFIFO{,Buffered}.r_rst documentation. NFC.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=858afd2d0fb81a0a0feac49cca62294e38f6258b;p=nmigen.git

lib.fifo: clarify AsyncFIFO{,Buffered}.r_rst documentation. NFC.
---

diff --git a/nmigen/lib/fifo.py b/nmigen/lib/fifo.py
index 49ac192..1d64aff 100644
--- a/nmigen/lib/fifo.py
+++ b/nmigen/lib/fifo.py
@@ -290,8 +290,8 @@ class AsyncFIFO(Elaboratable, FIFOInterface):
     r_data_valid="Valid if ``r_rdy`` is asserted.",
     r_attributes="""
     r_rst : Signal(1), out
-        Asserted while the FIFO is being reset by the write-domain reset (for at least one
-        read-domain clock cycle).
+        Asserted, for at least one read-domain clock cycle, after the FIFO has been reset by
+        the write-domain reset.
     """.strip(),
     w_attributes="")
 
@@ -469,8 +469,8 @@ class AsyncFIFOBuffered(Elaboratable, FIFOInterface):
     r_data_valid="Valid if ``r_rdy`` is asserted.",
     r_attributes="""
     r_rst : Signal(1), out
-        Asserted while the FIFO is being reset by the write-domain reset (for at least one
-        read-domain clock cycle).
+        Asserted, for at least one read-domain clock cycle, after the FIFO has been reset by
+        the write-domain reset.
     """.strip(),
     w_attributes="")