Update api.md to better match library 0.5.15#12
Open
dfluff wants to merge 3 commits intoPyhass:mainfrom
Open
Conversation
added 3 commits
September 25, 2023 14:59
I believe these updates are correct, although I'm currently unable to get device-login working myself. However, having these example documents being out-of-date to the current library caused some extra headaches.
session.md is definitely out of date, but I don't know the library well enough to update that page. api.md should now reflect the changes to the library to match 0.5.1 e.g. .deviceLogin() becomes .device_login(), etc. I've also changed some of the variable names to be snake_case rather than camelCase to match similar changes in the library method and variable names.
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
session.md is definitely out of date (and contradicts api.md), but I don't know the library well enough to update that page. I originally tried to update that page but gave up and reverted.
api.md should now reflect the changes to the library to better match 0.5.1
e.g. .deviceLogin() becomes .device_login(), etc.
I've added possibly the most important but previously missing step - the call to .device_registration(). Thanks to this comment for pointing me in the right direction!
I've also changed some of the variable names to be snake_case rather than camelCase to match similar changes in the library method and variable names.