Improvements to UI event object docs#444
Merged
florian-h05 merged 3 commits intoopenhab:mainfrom Jul 21, 2025
Merged
Conversation
Added rows for `event.event` and `event.payload` to the table. Reworded some of the warnings because manual triggers still have `event`. It's only when a rule calls another rule that the called rule doesn't have `event`. Solves issue openhab#316. Signed-off-by: Richard Koshak <rkoshak@users.noreply.github.com>
noticed a typo and decided to change some wording.
Contributor
Author
|
I tried to follow the instructions to rebase that commit that is missing the signoff. I failed. The first commit has the signoff and the second one is really minor. If I need to I'll close this PR and submit another one but I'm hoping this qualifies for the minimal changes exception. |
florian-h05
reviewed
Jul 18, 2025
Contributor
florian-h05
left a comment
florian-h05
left a comment
There was a problem hiding this comment.
One minor typo.
Don't worry because of DCO.
Co-authored-by: Florian Hotze <florianh_dev@icloud.com> Signed-off-by: Richard Koshak <rkoshak@users.noreply.github.com>
florian-h05
approved these changes
Jul 21, 2025
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
2 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.
[docs] Improvements to UI event object documentation
Description
Changed the wording to make it clear the
eventObject is only undefined when a rule is called from another rule.Added rows to the table to capture
event.eventandevent.payload.Closes #316 .