Skip to content

Commit 29bb5d3

Browse files
committed
Update resolve_timelines docstrings based on PR feedback
1 parent 7f7add8 commit 29bb5d3

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

‎ymmsl/v0_2/timeline_resolver.py‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,17 @@ def resolve_timelines(model: Model) -> None:
1616
"""Determine timelines for each component and their O_I and S ports in this model.
1717
1818
This function updates the timeline attributes of the components and ports in the
19-
model. Any of the following exceptions (which are a subclass of
20-
:class:`ResolveTimelineException`) will be raised when the model timelines are not
21-
consistent. See their description for more details:
22-
23-
- :class:`CyclicDependency`
24-
- :class:`TooManyReducerFilters`
25-
- :class:`InconsistentTimelines`
26-
- :class:`ConduitTimelineError`
19+
model. Raises any of below subclasses of :class:`ResolveTimelineException` when the
20+
model timelines are not consistent.
21+
22+
Raises:
23+
CyclicDependency: When messages to an F_INIT port of a component depend in some
24+
way on the output of that component.
25+
TooManyReducerFilters: When a conduit filter is applied to messages in the root
26+
timeline.
27+
InconsistentTimelines: When a component's F_INIT ports are not all connected to
28+
the same timeline.
29+
ConduitTimelineError: When a conduit connects incompatible timelines.
2730
"""
2831
checker = TimelineChecker(model)
2932
checker.check_consistent()
@@ -69,7 +72,7 @@ class TooManyReducerFilters(ResolveTimelineException):
6972
This error is raised when a reducer filter attempts to reduce a conduit that
7073
already sends on the root timeline. :class:`InconsistentTimelines` or
7174
:class:`ConduitTimelineError` may also be raised when too many reducer filters are
72-
applied.
75+
applied if that doesn't reduce the timeline beyond the root timeline.
7376
"""
7477

7578
def __init__(

0 commit comments

Comments
 (0)