No documentation for _FromXandFold C API functions

[pganssle]

BPO	36783
Nosy	@matrixise, @Mariatta, @pganssle, @csabella, @miss-islington, @SimiCode
PRs	bpo-36783: Added C API Documentation for Time_FromTimeAndFold and PyDateTime_FromDateAndTimeAndFold #13147 [3.7] bpo-36783: Added C API Documentation for Time_FromTimeAndFold and PyDateTime_FromDateAndTimeAndFold (GH-13147) #13156 bpo-36783: Add new references for C API Documentation changes #13204 [3.7] bpo-36783: Add new references for C API Documentation changes (GH-13204) #13413 Closed - Reason: Wrong bpo number #20650

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/Mariatta'
closed_at = <Date 2019-05-07.15:04:59.528>
created_at = <Date 2019-05-03.13:51:55.320>
labels = ['easy', 'type-feature', '3.8', '3.9', 'docs']
title = 'No documentation for _FromXandFold C API functions'
updated_at = <Date 2020-06-05.10:29:47.984>
user = 'https://github.com/pganssle'

bugs.python.org fields:

activity = <Date 2020-06-05.10:29:47.984>
actor = 'python-dev'
assignee = 'Mariatta'
closed = True
closed_date = <Date 2019-05-07.15:04:59.528>
closer = 'cheryl.sabella'
components = ['Documentation']
creation = <Date 2019-05-03.13:51:55.320>
creator = 'p-ganssle'
dependencies = []
files = []
hgrepos = []
issue_num = 36783
keywords = ['patch', 'easy']
message_count = 11.0
messages = ['341337', '341347', '341498', '341676', '341742', '341745', '341748', '342285', '342286', '342329', '342829']
nosy_count = 8.0
nosy_names = ['docs@python', 'python-dev', 'matrixise', 'Mariatta', 'p-ganssle', 'cheryl.sabella', 'miss-islington', 'edison.abahurire']
pr_nums = ['13147', '13156', '13204', '13413', '20650']
priority = 'low'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue36783'
versions = ['Python 3.8', 'Python 3.9']

[pganssle]

In Python 3.6, Time_FromTimeAndFold and PyDateTime_FromDateAndTimeAndFold were added as part of the PEP-495 implementation, but no documentation was added for the C API portions of this change: https://docs.python.org/3.7/c-api/datetime.html

The functions were added to this portion of the C API capsule: https://github.com/python/cpython/blob/master/Include/datetime.h#L173

Macros are here: https://github.com/python/cpython/blob/master/Include/datetime.h#L222

These functions should be documented, with ..versionadded:: 3.6

[pganssle]

This ticket should be reserved for the mentored sprint.

[simicode]

I'm working on this because I think it should be done complementarily with adding the test for PyDateTime_FromDateAndTimeAndFold at https://bugs.python.org/issue36782.

#Pycon2019 sprints

[simicode]

I have submitted a PR to address this. Awaiting Review.

[csabella]

New changeset 5765ecf by Cheryl Sabella (Edison A) in branch 'master':
bpo-36783: Added C API Documentation for Time_FromTimeAndFold and PyDateTime_FromDateAndTimeAndFold (GH-13147)
5765ecf

[csabella]

@edison.abahurire, thanks for the PR!

[miss-islington]

New changeset 146010e by Miss Islington (bot) in branch '3.7':
bpo-36783: Added C API Documentation for Time_FromTimeAndFold and PyDateTime_FromDateAndTimeAndFold (GH-13147)
146010e

[matrixise]

New changeset d28772a by Stéphane Wirtel (Edison A) in branch 'master':
bpo-36783: Add new references for C API Documentation changes (GH-13204)
d28772a

[matrixise]

Thank you for your PR.

@cherryL, the PR 13204 was not merged and the issue was closed :/

[pganssle]

@stéphane The reason this issue was closed before PR 13204 was merged is that PR 13147 was merged a bit prematurely due to a miscommunication, which is why Cheryl closed the issue. I was going to re-open it after we realized what happened, but since we were at sprints and I knew 13204 was coming soon, I didn't bother.

[miss-islington]

New changeset 951b161 by Miss Islington (bot) in branch '3.7':
bpo-36783: Add new references for C API Documentation changes (GH-13204)
951b161