Skip to content
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

Fix usb_cdc.Serial.read() documentation #10019

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

dhalbert
Copy link
Collaborator

Correct the current documentation. After thinking about this, I believe it's better not to emulate the somewhat idiosyncratic behavior of pyserial. Anyway wanting a certain behavior can do that with the current API.

@dhalbert dhalbert requested review from tannewt and jepler January 30, 2025 21:56
Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

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

Thanks!

@tannewt tannewt merged commit 5d39e46 into adafruit:main Jan 31, 2025
501 checks passed
@dhalbert dhalbert deleted the usb_cdc.Serial.read-doc branch February 4, 2025 18:32
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.

usb_cdc.serial.read() doc says it reads one byte, but it will read as much as possible
2 participants