hdl.ast: improve ClockSignal, ResetSignal documentation.
authorwhitequark <cz@m-labs.hk>
Sat, 15 Dec 2018 14:58:31 +0000 (14:58 +0000)
committerwhitequark <cz@m-labs.hk>
Sat, 15 Dec 2018 14:58:31 +0000 (14:58 +0000)
nmigen/hdl/ast.py

index c8c13ae4af4a73602405186acb8cb0084061fd76..31ea24a3cd047aa979ee644987de4bdac7e6c6d1 100644 (file)
@@ -606,10 +606,11 @@ class Signal(Value, DUID):
 
 
 class ClockSignal(Value):
-    """Clock signal for a given clock domain.
+    """Clock signal for a clock domain.
 
-    ``ClockSignal`` s for a given clock domain can be retrieved multiple
-    times. They all ultimately refer to the same signal.
+    Any ``ClockSignal`` is equivalent to ``cd.clk`` for a clock domain with the corresponding name.
+    All of these signals ultimately refer to the same signal, but they can be manipulated
+    independently of the clock domain, even before the clock domain is created.
 
     Parameters
     ----------
@@ -633,10 +634,11 @@ class ClockSignal(Value):
 
 
 class ResetSignal(Value):
-    """Reset signal for a given clock domain
+    """Reset signal for a clock domain.
 
-    ``ResetSignal`` s for a given clock domain can be retrieved multiple
-    times. They all ultimately refer to the same signal.
+    Any ``ResetSignal`` is equivalent to ``cd.rst`` for a clock domain with the corresponding name.
+    All of these signals ultimately refer to the same signal, but they can be manipulated
+    independently of the clock domain, even before the clock domain is created.
 
     Parameters
     ----------