From 92b2455f5a32b41f4d30744bd5567953b7ab6e2b Mon Sep 17 00:00:00 2001 From: whitequark Date: Sat, 15 Dec 2018 14:58:31 +0000 Subject: [PATCH] hdl.ast: improve ClockSignal, ResetSignal documentation. --- nmigen/hdl/ast.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/nmigen/hdl/ast.py b/nmigen/hdl/ast.py index c8c13ae..31ea24a 100644 --- a/nmigen/hdl/ast.py +++ b/nmigen/hdl/ast.py @@ -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 ---------- -- 2.30.2