Conversation
…dling documentation
The Cozytouch cloud tab used Server.SOMFY_EUROPE instead of Server.ATLANTIC_COZYTOUCH, contradicting the surrounding text.
- Add missing Command import in cloud example - Replace blocking time.sleep with await asyncio.sleep in both examples - Replace nonexistent device.id with device.device_url - Fix typo "succesfull" -> "successful"
The project uses prek as its pre-commit runner, not pre-commit directly.
These were commented out in the docs but listed in the README. Both servers exist in the codebase, so include them with a caveat about unsupported authentication.
Allows importing OverkizClient, Action, Command, Device, Event, Gateway, Setup, and State directly from pyoverkiz instead of requiring knowledge of internal submodule paths.
This reverts commit e223043.
Add missing OverkizCommandParam import used in the action groups example and close the code fence before the Limitations section.
A getting-started example should show the happy path, not a catch-all that swallows errors and exits silently.
Both pages covered SSL, rate limits, and auth failures. Merge all content into troubleshooting.md and remove error-handling.md.
The docs said 3.10+ but pyproject.toml requires >=3.12.
The docs workflow used 3.11 which is below the 3.12 minimum. Also bumped setup-python to v6 in the docs workflow and pinned the release workflow from 3.x to 3.12 for consistency.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s documentation and CI configuration to reflect the current library behavior and minimum supported Python version, while consolidating troubleshooting/error guidance.
Changes:
- Consolidates the removed
error-handling.mdcontent intodocs/troubleshooting.mdand updates MkDocs navigation accordingly. - Updates docs/README examples and contributor guidance to Python 3.12+, plus small example fixes (async sleep,
device_url, code fences). - Pins GitHub Actions docs/release workflows to Python 3.12 and updates
actions/setup-pythontov6where applicable.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Removes the nav entry for the deleted error-handling page. |
| docs/troubleshooting.md | Expands troubleshooting with retry guidance, common errors, SSL notes, and timeouts. |
| docs/index.md | Updates “Supported hubs” list and adds a footnote about auth support. |
| docs/getting-started.md | Updates minimum Python version and adjusts a server example. |
| docs/event-handling.md | Removes redundant example section to simplify the page. |
| docs/error-handling.md | Deletes the standalone error handling page (content moved elsewhere). |
| docs/device-control.md | Fixes/extends command parameter example and closes a code fence. |
| docs/contribute.md | Updates contributor guidelines to Python 3.12+. |
| README.md | Updates examples to be fully async, uses device_url, fixes spelling, and switches dev hook instructions to prek. |
| .github/workflows/release.yml | Pins release workflow runtime to Python 3.12. |
| .github/workflows/docs.yml | Updates setup-python action to v6 and pins docs build to Python 3.12. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
No description provided.