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.

Sign up for GitHub

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

Jump to bottom

Fix docstring for stdio #9544

Merged
merged 1 commit into from
Aug 21, 2024
Merged

Fix docstring for stdio #9544

merged 1 commit into from
Aug 21, 2024

Conversation

timdechant
Copy link

Fixes #9543.

Docstring for stdio indicates "FileIO", which is a binary IO stream. As detailed in #553, stdio is not binary by design; its docstring should indicate "StringIO".

@timdechant
fix: Docstring for stdio indicates binary adafruit#9543
e499614 
Docstring for stdio indicates "FileIO", which is a binary IO stream. As detailed in adafruit#553, stdio is not binary by design; its docstring should indicate "StringIO".
tannewt
tannewt approved these changes Aug 21, 2024
View reviewed changes
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.

Thank you! MicroPython probably has this issue as well. This is code from them.

@tannewt tannewt merged commit 147e301 into adafruit:main Aug 21, 2024
543 checks passed
@timdechant timdechant changed the title Fix: Docstring for stdio indicates binary #9543 Fix docstring for stdio Aug 22, 2024
@timdechant
Copy link
Author

MicroPython probably has this issue as well. This is code from them.

@tannewt Thanks for the pointer; I just had PR micropython#15708 approved for this, and there were a few recommendations that I'd like to bring back here. I have a branch ready for PR, but I want to check my approach.

I've just cherry-picked from to my mp branch to a cp branch. This double-upstream scenario is new to me, though; is there a preferred way to bring changes down from mp?

@tannewt
Copy link
Member

tannewt commented Sep 4, 2024

I've just cherry-picked from to my mp branch to a cp branch. This double-upstream scenario is new to me, though; is there a preferred way to bring changes down from mp?

Cherry picking is fine. It'll be re-done when we merge from MP but that's ok. No need to wait for us to merge MP in with the fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tannewt tannewt tannewt approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docstring for stdio indicates binary
2 participants
@timdechant @tannewt