Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Update English descriptions of weather and shade parameters #371

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

carterbox
Copy link

@carterbox carterbox commented Feb 22, 2025

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):

Screenshot 2025-02-23 124245

Screenshot 2025-02-23 124601

Screenshot 2025-02-23 124348

Types of changes

I believe this is an enhancement because only the descriptive text has changed. None of the entity names are affected.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Enhancement (non-breaking which updates existing code)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Other

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@carterbox carterbox changed the title Improve docs DOC: Update English descriptions of weather and shade parameters Feb 22, 2025
@carterbox carterbox marked this pull request as ready for review February 23, 2025 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant