Skip to content

Added more to docstring of datetime.timedelta #7458

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

Merged
merged 1 commit into from
Oct 19, 2018
Merged

Added more to docstring of datetime.timedelta #7458

merged 1 commit into from
Oct 19, 2018

Conversation

ChrisBarker-NOAA
Copy link
Contributor

Addition of signature and a bit more text to the class docstring for datetime.datetime, as discussed on python-dev 5 June, 2018.

https://mail.python.org/pipermail/python-dev/2018-June/153813.html

NOTE: it would be nice to get this back-ported to all actively maintained versions, but I have no idea how to trigger that.

But if this is approved, and someone lets me know how to do it, I'll be happy to do so.

Also -- I couldn't find clear guidance in PEP 257 for docstrings for C classes, so I hope this is close.

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

When your account is ready, please add a comment in this pull request
and a Python core developer will remove the CLA not signed label
to make the bot check again.

Thanks again to your contribution and we look forward to looking at it!

@ChrisBarker-NOAA
Copy link
Contributor Author

I have signed the CLA -- bpo user: ChrisBarker. My gitHub handle was incorrect.

@ChrisBarker-NOAA
Copy link
Contributor Author

thanks!

@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 19, 2018
(cherry picked from commit d6a61f2)

Co-authored-by: Chris Barker <[email protected]>
@miss-islington
Copy link
Contributor

Thanks @ChrisBarker-NOAA for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 19, 2018
(cherry picked from commit d6a61f2)

Co-authored-by: Chris Barker <[email protected]>
@bedevere-bot
Copy link

GH-9977 is a backport of this pull request to the 3.6 branch.

@vstinner
Copy link
Member

Thanks @ChrisBarker-NOAA! I checked help(datetime.timedelta) before merging, and the docstring is properly rendered. It's a nice enhancement, I merged it.

NOTE: it would be nice to get this back-ported to all actively maintained versions, but I have no idea how to trigger that.

I backported the change to Python 3.6 and 3.7. We have a bot doing the job for us!

(There is a conflict on Python 2.7, git cherry-pick fails to automatically backports the change. Honestly, I don't think that it's worth it to backport it up to Python 2.7.)

miss-islington added a commit that referenced this pull request Oct 19, 2018
(cherry picked from commit d6a61f2)

Co-authored-by: Chris Barker <[email protected]>
miss-islington added a commit that referenced this pull request Oct 19, 2018
(cherry picked from commit d6a61f2)

Co-authored-by: Chris Barker <[email protected]>
@ChrisBarker-NOAA
Copy link
Contributor Author

ChrisBarker-NOAA commented Oct 19, 2018 via email

@vstinner
Copy link
Member

I agree. Maybe one more reason to move off py2 :-)

LOL, yes, exactly!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants