Cleanup Xiaomi Miio docs#21861
Closed
rytilahti wants to merge 2 commits into
Closed
Conversation
|
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. |
syssi
approved these changes
May 28, 2022
Member
syssi
left a comment
There was a problem hiding this comment.
I would be happy to have this cleanup merged as first step.
Member
Author
|
This is still pending for feedback. |
Member
|
@rytilahti From who? |
Member
|
Because there hasn't been any activity on this PR for quite some time now, I've decided to close it for being stale. Feel free to re-open this PR when you are ready to pick up work on it again 👍 |
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Proposed change
The current
xiaomi_miiodocumentation is very verbose in terms of what types of sensors, switches, and other entities are available. As "miio" itself is a platform supporting a wide variety of different types of devices from a variety of different vendors, it does not make sense to document each and every available device-specific detail in the homeassistant documentation.The goal of this PR is to relieve both developers and documentation writers from the burden of keeping the information stored in the documentation in sync with the code. This (or a follow-up PR) should reorganize the docs to document the supported platforms and only document the custom services, alongside with known limitations if any.
Therefore, this cleanup PR removes the pieces of documentation that I personally consider unnecessary:
Note that this PR at places also removes information about the list of supported device models and device-specific limitations, which should be forced by the implementation. If wanted, such information (e.g., oscillation angles, available modes, ..) should be codified in a more general way (using entity descriptions?) to automatically generate documentation in the future.
Follow-up PRs will handle the following
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.