docs update on tendency inference#174
Open
DaanVanVugt wants to merge 1 commit into
Open
Conversation
DaanVanVugt
requested review from
MireilleSchneider,
SBlokhuizen and
maarten-ic
as code owners
June 24, 2026 15:40
SBlokhuizen
reviewed
Jun 25, 2026
SBlokhuizen
left a comment
SBlokhuizen
left a comment
Collaborator
There was a problem hiding this comment.
Looks good! I just have 2 minor comments about the documentation.
Contributor
Author
|
later prs introduce new tendencies, we should remember to include new auto-identification for these |
Point the type-inference refs at the per-tendency sections (added labels for constant/linear/smooth/periodic) instead of the page-top anchor, and drop the duplicated inference description in yaml_format in favour of the Available Tendencies page.
DaanVanVugt
force-pushed
the
feature/infer-tendency-type
branch
from
July 10, 2026 09:48
d6e8744 to
4dbbc5d
Compare
DaanVanVugt
changed the title
type is omitted
mikesndrs
approved these changes
Jul 10, 2026
SBlokhuizen
reviewed
Jul 14, 2026
| Each tendency defines the behavior of the signal over a specific time interval. You can chain multiple tendencies together to create complex waveforms. | ||
|
|
||
| If ``type`` is omitted it is inferred from the entry's keys: ``ref`` → :ref:`import <import-tendency>`, ``to`` → linear, ``time`` → :ref:`piecewise <piecewise-linear-tendency>`, ``value`` → constant; anything else defaults to ``linear`` (so a ``from``-only, ``rate``-only, or bare segment is still a linear ramp). Tendencies with no distinguishing key -- the periodic shapes, ``smooth``, and a value-less ``constant`` -- must name their ``type`` explicitly. | ||
| If ``type`` is omitted it is inferred from the entry's keys: ``ref`` → :ref:`import <import-tendency>`, ``to`` → :ref:`linear <linear-tendency>`, ``time`` → :ref:`piecewise <piecewise-linear-tendency>`, ``value`` → :ref:`constant <constant-tendency>`; anything else defaults to ``linear`` (so a ``from``-only, ``rate``-only, or bare segment is still a linear ramp). Tendencies with no distinguishing key -- the :ref:`periodic shapes <periodic-tendencies>`, :ref:`smooth <smooth-tendency>`, and a value-less :ref:`constant <constant-tendency>` -- must name their ``type`` explicitly. |
Collaborator
There was a problem hiding this comment.
This would make a lot more sense with a small example in my opinion.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When a tendency entry has no explicit
type, infer it from its keysinstead of always defaulting to linear:
to-> linear,time->piecewise,
value-> constant. Anything else falls back to linear, so a linear tendency does not requireto(a from-only/rate-only/bare segment is still linear and takes its endpoints from its neighbours).A segment whose distinguishing key is absent must name its type explicitly: the periodic shapes, smooth, and a value-less constant (a bare {duration} is read as a linear ramp).
Documents the behaviour (yaml_format + tendencies) and tests the inference, the linear-without-
toforms, the value-less ambiguity, and that an explicit type takes precedence.