Documentation: Some Unicode object functions don't indicate whether they return a new reference

[lioncash]

BPO	32077
Nosy	@serhiy-storchaka, @lioncash, @miss-islington
PRs	bpo-32077: Documentation: Some Unicode object functions don't indicate whether they return a new reference #4472 bpo-32077: Documentation: Some Unicode object functions don't indicate whether they return a new reference #11243 [3.7] bpo-32077: Update refcounts.dat for Unicode object functions. (GH-11243) #11245 [3.6] bpo-32077: Update refcounts.dat for Unicode object functions. (GH-11243) #11246

^{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 = None
closed_at = <Date 2018-12-19.20:13:42.417>
created_at = <Date 2017-11-20.00:00:14.331>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = "Documentation: Some Unicode object functions don't indicate whether they return a new reference"
updated_at = <Date 2018-12-19.20:13:42.414>
user = 'https://github.com/lioncash'

bugs.python.org fields:

activity = <Date 2018-12-19.20:13:42.414>
actor = 'serhiy.storchaka'
assignee = 'docs@python'
closed = True
closed_date = <Date 2018-12-19.20:13:42.417>
closer = 'serhiy.storchaka'
components = ['Documentation']
creation = <Date 2017-11-20.00:00:14.331>
creator = 'Mathew M.'
dependencies = []
files = []
hgrepos = []
issue_num = 32077
keywords = ['patch']
message_count = 6.0
messages = ['306516', '306518', '306519', '332161', '332162', '332163']
nosy_count = 4.0
nosy_names = ['docs@python', 'serhiy.storchaka', 'Mathew M.', 'miss-islington']
pr_nums = ['4472', '11243', '11245', '11246']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue32077'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8']

[lioncash]

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.

[serhiy-storchaka]

C API functions return new references by default. It needs to be explicitly documented only when the function returns a borrowed reference.

[serhiy-storchaka]

Ah, you have changed just refcounts.dat! This is good.

[serhiy-storchaka]

New changeset b2f642c by Serhiy Storchaka (Mat M) in branch 'master':
bpo-32077: Update refcounts.dat for Unicode object functions. (GH-11243)
b2f642c

[miss-islington]

New changeset 29d4e30 by Miss Islington (bot) in branch '3.7':
bpo-32077: Update refcounts.dat for Unicode object functions. (GH-11243)
29d4e30

[serhiy-storchaka]

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.