8000 Improve the io module documentation by geryogam · Pull Request #15099 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Improve the io module 8000 documentation #15099

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
Merged
merged 9 commits into from
Sep 11, 2019
Merged

Improve the io module documentation #15099

merged 9 commits into from
Sep 11, 2019

Conversation

geryogam
Copy link
Contributor
@geryogam geryogam commented Aug 3, 2019 •
edited
Loading

This PR will apply the following changes to the io module documentation:

  • add the missing mention of the TextIOBase parent class to the StringIO class description;
  • make it clear that the newline parameter of the StringIO class works like that of the TextIOWrapper class except when writing to a stream with newline=None;
  • improve phrasing consistency.

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Aug 3, 2019
@geryogam geryogam changed the title Update io.rst Update the io module documentation Aug 4, 2019
@geryogam geryogam changed the title Update the io module documentation Update the io module documentation Aug 5, 2019
@geryogam geryogam changed the title Update the io module documentation Improve the io module documentation Aug 7, 2019
epicfaace
epicfaace reviewed Aug 23, 2019
View reviewed changes
geryogam and others added 2 commits August 24, 2019 12:19
@geryogam @epicfaace
Apply suggestions from code review
e48a215 
Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com>
@geryogam
Update io.rst
a287500
@geryogam
Copy link
Contributor Author
geryogam commented Aug 24, 2019 •
edited
Loading

@epicfaace Thank you for the review. I have applied some of your suggestions.

epicfaace
epicfaace reviewed Aug 24, 2019
View reviewed changes
Copy link
Contributor
@epicfaace epicfaace left a comment

Choose a reason for hiding this comment

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

Can you fix the trailing whitespace errors so that the docs CI build passes?

python tools/rstlint.py -i tools -i ./venv -i README.rst
[1] library/io.rst:674: trailing whitespace
[1] library/io.rst:711: trailing whitespace
[1] library/io.rst:966: trailing whitespace
3 problems with severity 1 found.

@geryogam
Copy link
Contributor Author
10000 geryogam commented Aug 24, 2019

@epicfaace Thanks, updated.

@geryogam
Copy link
Contributor Author
geryogam commented Sep 3, 2019

@Mariatta If you have some time, could you review this PR?

@mariatta-bot
Copy link

🤖 Mariatta was mentioned, but she's out of open source until end of September 2019. Hopefully someone else can look into this in the meantime.

@willingc willingc self-assigned this Sep 11, 2019
willingc
willingc requested changes Sep 11, 2019
View reviewed changes
Copy link
Contributor
@willingc willingc left a comment

Choose a reason for hiding this comment

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

Thanks @maggyero for the PR. A few subtle changes are needed and then this PR should be ready to merge. Thanks 👍

@bedevere-bot
Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

geryogam and others added 3 commits September 11, 2019 15:01
@geryogam @willingc
Apply suggestions from code review
8faee39 
Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>
@geryogam
Update io.rst
f8235fd
@geryogam
Update io.rst
9b82aa6
@geryogam
Copy link
Contributor Author

Thanks @willingc, I have made the requested changes; please review again.

@bedevere-bot
Copy link

Thanks for making the requested changes!

@willingc: please review the changes made to this pull request.

willingc
willingc approved these changes Sep 11, 2019
View reviewed changes
Copy link
Contributor
@willingc willingc left a comment

Choose a reason for hiding this comment

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

Changes look good. Thanks @maggyero.

@willingc willingc merged commit 3b58a70 into python:master Sep 11, 2019
@geryogam geryogam deleted the patch-10 branch September 11, 2019 15:08
@geryogam
Copy link
Contributor Author

Thanks @willingc for the review!

@geryogam
Copy link
Contributor Author

By the way @willingc, usually these documentation improvements are backported to the 3.7 and 3.8 branches (like in my PRs #14274, #14098, #14061). Could we do it as well for this PR?
F438

@miss-islington
Copy link
Contributor

Thanks @maggyero for the PR, and @willingc for merging it 🌮🎉.. I'm working now to backport this PR to: 3.7.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Thanks @maggyero for the PR, and @willingc for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry, @maggyero and @willingc, I could not cleanly backport this to 3.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 3b58a70d9cf1c0f963adce9b07060116b2775687 3.7

@miss-islington
Copy link
Contributor

Sorry @maggyero and @willingc, I had trouble checking out the 3.8 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 3b58a70d9cf1c0f963adce9b07060116b2775687 3.8

@geryogam
Copy link
Contributor Author

@willingc the automatic backport of this PR failed. Should I do anything to make it work?

DinoV pushed a commit to DinoV/cpython that referenced this pull request Sep 12, 2019
@geryogam @willingc @DinoV
Improve the io module documentation (pythonGH-15099)
9a47c1f 
* Update io.rst

* Apply suggestions from code review

Co-Authored-By: Ashwin Ramaswami <aramaswamis@gmail.com>

Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@epicfaace epicfaace epicfaace approved these changes

@willingc willingc willingc approved these changes

Assignees

@willingc willingc

Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@geryogam @mariatta-bot @bedevere-bot @miss-islington @epicfaace @willingc @the-knights-who-say-ni
0