-
-
Notifications
You must be signed in to change notification settings - Fork 190
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
Update docs for newer devices and DeviceConfig #614
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #614 +/- ##
=======================================
Coverage 85.23% 85.23%
=======================================
Files 38 38
Lines 3475 3475
Branches 888 888
=======================================
Hits 2962 2962
Misses 432 432
Partials 81 81 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks much better, thanks 👍 just a minor maintenance nit that should be changed in all changed chunks if applicable.
Would you also mind adding somewhere a note that |
Added to the |
a951483
to
296c11c
Compare
https://python-kasa--614.org.readthedocs.build/en/614/discover.html should be modified to contain at least some basic description about how the discovery works and how it should be used. Doesn't need to be anything fancy, but a quick description and a copy-pasteable code example that can be run as-is would be great. Same would also be great in the smartdevice/common api, i.e., just a very simple ready-to-use example on how to get started if you have never used the lib. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If no command is given, the
state
command will be executed to query the device state.
The "Command-line usage" section in cli.rst should also be adapted to describe briefly the options related to authentication, no need to go deep into details but giving enough information get get one started from zero.
All comments now addressed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, thanks! 🥇
I added a couple of very minor nits in places where I think rewording makes sense, feel free to adjust or keep it as it is, your call.
All comments now addressed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks! 👍
As per issue #600