Clarify docs for binary_sensor class 'opening' #2079
Merged
Conversation
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
The documentation for the 'opening' class of binary_sensor left the interpretation of On and Off undefined. Additionally, the intro paragraph claimed that "On" is "Closed" and "Off" is "Open" which is the opposite of common usage that I've seen in example configurations. This commit explicitly states that On==Open and Off=Closed and amends the examples in the leading paragraph. Confirmed in Gitter chat that this is appropriate: @balloob: "I would assume that “on” is open as it’s the special case. Assuming doors/windows etc are usually closed. With smoke, detecting smoke is the special case"
|
@nugget, thanks for your PR! By analyzing the history of the files in this pull request, we identified @fabaff, @robbiet480 and @balloob to be potential reviewers. |
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.
Description:
The documentation for the 'opening' class of binary_sensor left the
interpretation of On and Off undefined. Additionally, the intro paragraph
claimed that "On" is "Closed" and "Off" is "Open" which is the opposite of
common usage that I've seen in example configurations.
This commit explicitly states that On==Open and Off=Closed and amends the
examples in the leading paragraph.
Confirmed in Gitter chat that this is appropriate:
@balloob: "I would assume that “on” is open as it’s the special case.
Assuming doors/windows etc are usually closed.
With smoke, detecting smoke is the special case"