Update documents.rst #1514
Open
Update documents.rst #1514
Conversation
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
I think it's best to replace `StringIO` with `BytesIO` since we are working with bytes. This ensures that beginners, or anyone skimming the documentation and copying code, end up with correct and functional code.
scanny
reviewed
Aug 21, 2025
| @@ -78,11 +78,11 @@ a document like so:: | |||
| # or | |||
|
|
|||
| with open('foobar.docx', 'rb') as f: | |||
| source_stream = StringIO(f.read()) | |||
| source_stream = BytesIO(f.read()) | |||
There was a problem hiding this comment.
Hmm, interesting. I'm sure this is an artifact of this documentation being written during the Python 2 era, when StringIO actually meant "read bytes".
I'll put it on the shortlist and fix it up next time I'm in there.
|
Alright noted |
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.
I think it's best to replace
StringIOwithBytesIOsince we are working with bytes. This ensures that beginners, or anyone skimming the documentation and copying code, end up with correct and functional code.