Repository navigation
[Documentation Issue] websocket client docs refer to nonexistent async API #236
Description
Activity
Hi! If you were to look at the actual source that those docs are generated from, you would realize that an async WebSocket client was added in #212 just a few weeks ago.
However, you do bring up a good point that the docs don't match what is actually published on PyPI. Additionally, upon further investigation I don't seem to be able to see past versions of the documentation on the readthedocs, which is rather unfortunate.
Rest assured, those docs are not hallucinated. However, I do apologize for the inconsistency.
To be completely transparent, there are some big restructuring changes about to be published in the open PRs. But for those who wish to continue to use past versions of the library, we'll make sure to look into publishing the docs for past versions of the library.
@spookyvision I just fixed this on readthedocs. It had to go in and manually enable each of the previous versions. All of the ones pre-5.0.0 failed to build because of the poetry-export-plugin not being installed, and our poetry version not being pinned in the .readthedocs.yaml file at the time. Unless I hear otherwise, I'm going to assume it's not worth it to have those docs up.
However, the default page of the docs is now https://homeassistantapi.readthedocs.io/en/stable/, which points to the latest release tag (as time of writing is 5.0.3), which is what you need right now. Going forward, I think we'll keep a most of the tags of every major version published.
Note: according to readthedocs:
The
latestversion points to the most up to date development code. If you develop on a branch that is different than the default for your version control system, set the Default Branch to the branch you use.So in the future, keep in mind that changes on the
latestpage of the docs may not be available on PyPI yet.Again, sorry about all of this. We should've had this figured out by now.
Your problem with the documentation [e.g. Missing Documentation, Typo, Invalid Code Example, etc]
Elaborate on the problem here.
use_asyncas an optional parameter, but it does not exist in the source (as stated in the usage section: "You can’t use the WebsocketClient with async/await yet because we haven’t implemented it yet.")WebsocketClient.async_*methods.hallucinated? rude.