Rename open_serial_device to open_device - #29
Merged
Conversation
The factory reads serial.open_device at the call site, matching the module-import convention the examples and READMEs already use.
bruno-f-cruz
approved these changes
Aug 19, 2026
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
2 participants
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.
The factory now reads
serial.open_deviceat the call site, matching the convention the examples and READMEs already follow of importing the module and qualifying at the point of use. Under that convention the old spelling said serial twice, since the module qualifier already carries it.No alias is kept for the old name. The packages are pre-release, so the rename is free now and would cost a deprecation cycle later.
This is a rename with no behaviour change. It covers the definition and its three overloads, the package export, the four conformance probes, the
::: harp.serial.open_devicedirective on the API page, and the call sites in the root README, both package READMEs and the four example scripts.