Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new documentation page to help users migrate from pyserial/pyserial-asyncio to serialx, and updates the docs build configuration to support the new page’s Sphinx directives.
Changes:
- Add a new “Migrating from pyserial” how-to guide covering packaging, common API renames, and async modem-pin usage.
- Wire the new guide into the docs toctree.
- Enable
sphinx_designand add docs-only dependencies needed for the new directives; minor docstring warning formatting tweaks for deprecated aliases.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
serialx/common.py |
Adjusts deprecated-alias docstring warning formatting for consistency. |
pyproject.toml |
Adds docs optional deps (sphinx-design, sphinx-autobuild) required for the new docs content/workflow. |
docs/index.md |
Adds the new migration guide to the “How-to” toctree. |
docs/how-to/pyserial-migration.md |
New migration guide documenting common rename patterns and async best practices. |
docs/conf.py |
Enables the sphinx_design Sphinx extension used by the new guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #71 +/- ##
=======================================
Coverage 90.77% 90.77%
=======================================
Files 21 21
Lines 3348 3348
=======================================
Hits 3039 3039
Misses 309 309 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
A small guide to cover 99% of migration cases. If you're not subclassing anything and just use public APIs, this will be more than enough to migrate an existing project.