lib.fifo: clarify AsyncFIFO{,Buffered}.r_rst documentation. NFC.
authorCatherine <whitequark@whitequark.org>
Mon, 13 Dec 2021 09:53:29 +0000 (09:53 +0000)
committerLuke Kenneth Casson Leighton <lkcl@lkcl.net>
Fri, 31 Dec 2021 20:30:04 +0000 (20:30 +0000)
nmigen/lib/fifo.py

index 49ac192de0f04b517eb998dc159219993e37292e..1d64affef156af51867aff2a9d572e503340486c 100644 (file)
@@ -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="")