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

bpo-36523: Add docstring to io.IOBase.writelines #12683

Merged

Conversation

n0npax
Copy link
Contributor

@n0npax n0npax commented Apr 4, 2019

Add docs to io.IOBase.writelines

https://bugs.python.org/issue36523

@terryjreedy terryjreedy changed the title bpo-36523: Fix missing docs writelines io base issue 36523 bpo-36523: Add docstring to io.IOBase.writelines Apr 5, 2019
@terryjreedy terryjreedy requested a review from vadmium April 5, 2019 19:19
@terryjreedy
Copy link
Member

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'.

@vadmium
Copy link
Member

vadmium commented Apr 6, 2019

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 __doc__ attributes.

@n0npax
Copy link
Contributor Author

n0npax commented Apr 7, 2019

Hi @vadmium, @terryjreedy,
Seems a blank line is required due to: https://mail.python.org/pipermail/python-dev/2013-June/127110.html
Lack of a blank line causes a clinic error: https://github.com/python/cpython/blob/master/Tools/clinic/clinic.py#L4808

@methane
Copy link
Member

methane commented Apr 22, 2019

Same docstring should be added to Lib/_pyio.py

@the-knights-who-say-ni
Copy link

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!

@n0npax
Copy link
Contributor Author

n0npax commented Apr 22, 2019

@methane Thanks for the suggestion, I just added requested docs to _pyio

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.

@methane methane merged commit ab86521 into python:master Apr 22, 2019
@miss-islington
Copy link
Contributor

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

@miss-islington
Copy link
Contributor

Sorry, @n0npax and @methane, I could not cleanly backport this to 3.7 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker ab86521a9d9999731e39bd9056420bb7774fd144 3.7

n0npax added a commit to n0npax/cpython that referenced this pull request Apr 22, 2019
@bedevere-bot
Copy link

GH-12905 is a backport of this pull request to the 3.7 branch.

methane pushed a commit that referenced this pull request Apr 22, 2019
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.

7 participants