classification
Title: Documentation: Some Unicode object functions don't indicate whether they return a new reference
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.8, Python 3.7, Python 3.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Mathew M., docs@python, miss-islington, serhiy.storchaka
Priority: normal Keywords: patch

Created on 2017-11-20 00:00 by Mathew M., last changed 2018-12-19 20:13 by serhiy.storchaka. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 4472 closed Mathew M., 2017-11-20 00:06
PR 11243 merged Mathew M., 2018-12-19 17:02
PR 11245 merged miss-islington, 2018-12-19 19:13
PR 11246 closed miss-islington, 2018-12-19 19:13
Messages (6)
msg306516 - (view) Author: Mathew M. (Mathew M.) * Date: 2017-11-20 00:00
This is just something I've noticed when browsing the C API documentation for Unicode objects.

For example, the documentation entry for PyUnicode_DecodeMBCSStateful lacks the "Return value: New reference", etc.
msg306518 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2017-11-20 00:08
C API functions return new references by default. It needs to be explicitly documented only when the function returns a borrowed reference.
msg306519 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2017-11-20 00:11
Ah, you have changed just refcounts.dat! This is good.
msg332161 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2018-12-19 19:13
New changeset b2f642ccd2f65d2f3bf77bbaa103dd2bc2733734 by Serhiy Storchaka (Mat M) in branch 'master':
bpo-32077: Update refcounts.dat for Unicode object functions. (GH-11243)
https://github.com/python/cpython/commit/b2f642ccd2f65d2f3bf77bbaa103dd2bc2733734
msg332162 - (view) Author: miss-islington (miss-islington) Date: 2018-12-19 20:03
New changeset 29d4e309b1b4dfb26d65d83c683002911c066dec by Miss Islington (bot) in branch '3.7':
bpo-32077: Update refcounts.dat for Unicode object functions. (GH-11243)
https://github.com/python/cpython/commit/29d4e309b1b4dfb26d65d83c683002911c066dec
msg332163 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2018-12-19 20:13
Sorry, I forget about this issue and remembered it only after creating similar patch from scratch. PR 11247 is what left from it after merging your patch.
History
Date User Action Args
2018-12-19 20:13:42serhiy.storchakasetstatus: open -> closed
versions: + Python 3.6, Python 3.7, Python 3.8
messages: + msg332163

resolution: fixed
stage: patch review -> resolved
2018-12-19 20:03:25miss-islingtonsetnosy: + miss-islington
messages: + msg332162
2018-12-19 19:13:33miss-islingtonsetpull_requests: + pull_request10475
2018-12-19 19:13:27miss-islingtonsetpull_requests: + pull_request10474
2018-12-19 19:13:25serhiy.storchakasetmessages: + msg332161
2018-12-19 17:02:23Mathew M.setpull_requests: + pull_request10473
2017-11-20 00:11:06serhiy.storchakasetmessages: + msg306519
2017-11-20 00:08:09serhiy.storchakasetnosy: + serhiy.storchaka
messages: + msg306518
2017-11-20 00:06:25Mathew M.setkeywords: + patch
stage: patch review
pull_requests: + pull_request4407
2017-11-20 00:00:14Mathew M.create