Skip to content

Commit 009f4b1

Browse files
authored
Docs: clarify multiple signals must all be true (#5086)
1 parent 055562b commit 009f4b1

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/guides/signals.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ It then divides those into _batches_ (configured with the model's [batch_size](.
2424

2525
Signal checking functions examines a batch of time intervals. The function is always called with a batch of time intervals (DateTimeRanges). It can also optionally be called with key word arguments. It may return `True` if all intervals are ready for evaluation, `False` if no intervals are ready, or the time intervals themselves if only some are ready. A checking function is defined with the `@signal` decorator.
2626

27+
!!! note "One model, multiple signals"
28+
29+
Multiple signals may be specified for a model. SQLMesh categorizes a candidate interval as ready for evaluation if **all** the signal checking functions determine it is ready.
30+
2731
## Defining a signal
2832

2933
To define a signal, create a `signals` directory in your project folder. Define your signal in a file named `__init__.py` in that directory (you can have additional python file names as well).

0 commit comments

Comments
 (0)