DOC: Update English descriptions of weather and shade parameters #371
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
Updates README and English translation with more detailed descriptions of weather conditions and shading parameters.
Motivation and Context
These descriptions attempt to make clearer to new users the reason for these parameters and how to set them. When I was setting up this integration for the first time, I was unable to determine the meaning of these parameters from the configuration menus. I had to come to GitHub to read through the README and issue tracker in order to understand what these parameters were and how to set them.
The weather conditions description was too ambiguous because it just states that selecting weather "enable automatic window control". This is not helpful because the everything in this integration enables automatic control of the cover. The description is now better because it tells the user that the weather conditions they select are the ones that should correspond to "sunny" conditions.
The shaded area parameter is renamed to "Glare Zone" because the parameter measures the size of the area in which glare will happen. I think this makes it more obvious that the parameter controls the entry of direct sunlight into the room while still allowing diffuse light from outside into the space. The description of this parameter is also updated to directly reference sunlight directly. It's also more intuitive to frame the parameter as controlling something (sunlight) as opposed to controlling the absence of something (darkness).
How has this been tested?
I replaced this integration with my fork in HACS.
Screenshots (if appropriate):
Types of changes
I believe this is an enhancement because only the descriptive text has changed. None of the entity names are affected.
Checklist