added documentation of early returns #457
Merged
Conversation
This file contains 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
configuration/rules-dsl.md
Outdated
| @@ -207,6 +207,19 @@ Besides the implicitly available variables for items and commands/states, rules | |||
| - Every rule that has at least one command event trigger, will have the variable `receivedCommand` available, which can be used inside the execution block. | |||
| - Every rule that has at least one status change event trigger, will have the variable `previousState` available, which can be used inside the execution block. | |||
|
|
|||
| ### Early returns | |||
|
|
|||
| Similar to Java, it is possible to return early from a rule, not executing the rest of the statements like this: | |||
There was a problem hiding this comment.
Remove "Similar to Java" ?
configuration/rules-dsl.md
Outdated
| sendCommand(Heating, ON) | ||
| ``` | ||
|
|
||
| Caveat: Please note the semicolon after the return statement. If you leave it out, the next line might still get executed. |
There was a problem hiding this comment.
"might" doesn't create confidence in a determined openHAB behavior. In my opinion just leave it with the first sentence or add something as a short rationale like "which terminates the command without an additional argument." wdyt?
Signed-off-by: Simon Kaufmann <simon.kfm@googlemail.com>
|
Thanks for your feedback! I have updated the PR. |
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Signed-off-by: Simon Kaufmann simon.kfm@googlemail.com