[issue36783] No documentation for _FromXandFold C API functions
New submission from Paul Ganssle <p.ganssle@gmail.com>: 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` ---------- assignee: docs@python components: Documentation keywords: easy messages: 341337 nosy: docs@python, p-ganssle priority: low severity: normal status: open title: No documentation for _FromXandFold C API functions versions: Python 3.8, Python 3.9 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Change by Paul Ganssle <p.ganssle@gmail.com>: ---------- nosy: +Mariatta, cheryl.sabella _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Paul Ganssle <p.ganssle@gmail.com> added the comment: This ticket should be reserved for the mentored sprint. ---------- assignee: docs@python -> Mariatta _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Edison Abahurire <abahedison@gmail.com> added the comment: 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 ---------- nosy: +edison.abahurire _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- keywords: +patch pull_requests: +13060 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Edison Abahurire <abahedison@gmail.com> added the comment: I have submitted a PR to address this. Awaiting Review. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Cheryl Sabella <cheryl.sabella@gmail.com> added the comment: New changeset 5765ecf79fcee987f2f97c246c64b494324dfd33 by Cheryl Sabella (Edison A) in branch 'master': bpo-36783: Added C API Documentation for Time_FromTimeAndFold and PyDateTime_FromDateAndTimeAndFold (GH-13147) https://github.com/python/cpython/commit/5765ecf79fcee987f2f97c246c64b494324... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +13073 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Change by Cheryl Sabella <cheryl.sabella@gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Cheryl Sabella <cheryl.sabella@gmail.com> added the comment: @edison.abahurire, thanks for the PR! ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 146010ea42fb949a48a1b79a13503995a5176833 by Miss Islington (bot) in branch '3.7': bpo-36783: Added C API Documentation for Time_FromTimeAndFold and PyDateTime_FromDateAndTimeAndFold (GH-13147) https://github.com/python/cpython/commit/146010ea42fb949a48a1b79a13503995a51... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- pull_requests: +13115 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Stéphane Wirtel <stephane@wirtel.be> added the comment: New changeset d28772ab6967fea136c0707f0207673ebad66f61 by Stéphane Wirtel (Edison A) in branch 'master': bpo-36783: Add new references for C API Documentation changes (GH-13204) https://github.com/python/cpython/commit/d28772ab6967fea136c0707f0207673ebad... ---------- nosy: +matrixise _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Stéphane Wirtel <stephane@wirtel.be> added the comment: Thank you for your PR. @Cherryl, the PR 13204 was not merged and the issue was closed :/ ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Paul Ganssle <p.ganssle@gmail.com> added the comment: @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. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +13324 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 951b161857a840d4d14de0a5a6610e212d78ab68 by Miss Islington (bot) in branch '3.7': bpo-36783: Add new references for C API Documentation changes (GH-13204) https://github.com/python/cpython/commit/951b161857a840d4d14de0a5a6610e212d7... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- nosy: +python-dev nosy_count: 7.0 -> 8.0 pull_requests: +19870 pull_request: https://github.com/python/cpython/pull/20650 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36783> _______________________________________
participants (6)
-
Cheryl Sabella -
Edison Abahurire
-
miss-islington
-
Paul Ganssle
-
Roundup Robot
-
Stéphane Wirtel