Skip to content

change wording on android version requirement#1197

Open
harmpter wants to merge 1 commit intohome-assistant:masterfrom
harmpter:patch-1
Open

change wording on android version requirement#1197
harmpter wants to merge 1 commit intohome-assistant:masterfrom
harmpter:patch-1

Conversation

@harmpter
Copy link
Copy Markdown

Android 12 or older -> Android 12 or below

Proposed change

Hi, this is my first pull request and I hope I'm doing it correctly.
The docs point out that command_bluetooth only works on android versions Android 12 or older, which is easily confused for Android 12+ in a rush. I would like to change the word "older" to "below", as I find it more straightforward and prevents misunderstanding of the fact, that it only works up until Android 12, not from Android 12+ and above.

Type of change

  • Document existing features within Home Assistant Companion App
  • Document new or changing features for which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Remove stale or deprecated documentation

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.

Additional information

Android 12 or older -> Android 12 or below
@jpelgrom
Copy link
Copy Markdown
Member

jpelgrom commented Apr 24, 2025

Thanks for the suggestion.

However, the documentation consistently uses "or older" for this kind of requirement, and in the text it is still a 5 letter word so I don't really see how this is less easily confused.

While the issues you linked are relevant, they are created around the time the change occurred. As such I believe the update changing the behavior is the reason for the issues, rather than the documentation.

@harmpter
Copy link
Copy Markdown
Author

harmpter commented Apr 24, 2025

Thank you! I see, I wasn't aware of that.

Regarding the semantics; while "or older" is definitely not incorrect, it is easy to make the mistake of thinking of it as "greater number = greater age = older" because that's how age usually works.
I think "or below" doesn't carry that same ambiguity. An alternative would be "or earlier" with the added bonus of being a 7 letter word haha.

But I now recognize and agree that the issues were created around the time Android 13 rolled out, that's fair and I missed that.
But, we have no way to estimate how many other users have fallen into the same trap as I have, because the existing issues effectively prevent duplicate issues from being created. So, I would still argue to make some kind of change.

Can I add another commit to this pull to at least keep the wording consistent across the documentation? If yes, I will try to do that. Please let me know what you think about the older/below/earlier thingy.

@jpelgrom
Copy link
Copy Markdown
Member

Looking at the style guide recently adopted for Home Assistant documentation for earlier, it looks like that's the way to go:

Use or earlier or previous instead of or lower to refer to all versions of a product that precede a particular release if the statement is accurate for all preceding releases.

There are a lot of places where "or older" is currently used - so if you want to update it, please update it everywhere for consistency.

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.

2 participants