Skip to content

Commit

Permalink
Doc review
Browse files Browse the repository at this point in the history
  • Loading branch information
fzi-hielscher committed Dec 12, 2024
1 parent c0f68fa commit 54a2f26
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions include/circt/Dialect/Sim/SimOps.td
Original file line number Diff line number Diff line change
Expand Up @@ -373,14 +373,15 @@ def OnEdgeOp : SimOp<"on_edge", [
Pure,
DeclareOpInterfaceMethods<InferTypeOpInterface, ["inferReturnTypes"]>
]> {
let summary = "Invoke a trigger on a clock edge event.";
let summary = "Create a trigger that gets invoked on a clock edge event.";
let arguments = (ins ClockType:$clock, EventControlAttr:$event);
let results = (outs EdgeTriggerType:$result);
let assemblyFormat = "$event $clock attr-dict";
}

def OnInitOp : SimOp<"on_init", [Pure]> {
let summary = "Invoke a trigger at the start of simulation.";
let summary =
"Create a trigger that gets invoked at the start of simulation.";
let results = (outs InitTriggerType:$result);
let assemblyFormat = "attr-dict";
}
Expand Down Expand Up @@ -408,7 +409,7 @@ def TriggerSequenceOp : SimOp<"trigger_sequence", [
def YieldSeqOp : SimOp<"yield_seq",[
Terminator, HasParent<"circt::sim::TriggeredOp">
]> {
let summary = [{Yield results form a triggerd region with 'seq'
let summary = [{Yield results from a triggerd region with 'seq'
(i.e. register-like) semantics."}];
let description = [{
Terminates a triggered region and produces the given list of values.
Expand Down

0 comments on commit 54a2f26

Please sign in to comment.