Skip to content

Add a pyserial migration guide#71

Merged
puddly merged 3 commits intodevfrom
puddly/migration-guide
Apr 23, 2026
Merged

Add a pyserial migration guide#71
puddly merged 3 commits intodevfrom
puddly/migration-guide

Conversation

@puddly
Copy link
Copy Markdown
Owner

@puddly puddly commented Apr 23, 2026

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.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_design and 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.

Comment thread docs/how-to/pyserial-migration.md Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.77%. Comparing base (9d90d73) to head (095ab53).
⚠️ Report is 1 commits behind head on dev.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@puddly puddly merged commit 0d770f6 into dev Apr 23, 2026
55 of 58 checks passed
@puddly puddly deleted the puddly/migration-guide branch April 23, 2026 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants