-
-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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
bpo-36523: Add docstring to io.IOBase.writelines #12683
bpo-36523: Add docstring to io.IOBase.writelines #12683
Conversation
The text is copied from the io module docs and looks correct. I am not familiar with the proper formatting in .c files, in particular, the initial blank line. I changed the titles and news items because 'add documentation' usually means 'add to the .rst doc file'. |
Looks okay to me. If you are worried about the Arg Clinic formatting Terry, I would compare it to the surrounding functions (e.g. readlines directly above), or the existing io.BytesIO.writelines Clinic code, and check the resulting |
Hi @vadmium, @terryjreedy, |
Same docstring should be added to Lib/_pyio.py |
Hello, and thanks for your contribution! I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA). Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue. You can check yourself to see if the CLA has been received. Thanks again for your contribution, we look forward to reviewing it! |
3c204e4
to
a105a89
Compare
@methane Thanks for the suggestion, I just added requested docs to Anyway, I'm really sorry for notification to all reviewers. Accidentally I made a merge in my branch and a lot of reviewers were added to this PR. I'm really Sorry guys. |
Sorry, @n0npax and @methane, I could not cleanly backport this to |
(cherry picked from commit ab86521) Co-authored-by: Marcin Niemira <[email protected]>
GH-12905 is a backport of this pull request to the 3.7 branch. |
Add docs to
io.IOBase.writelines
https://bugs.python.org/issue36523