Py_UNICODE_* functions are undocumented

[stutzbach]

BPO	8649
Nosy	@terryjreedy, @ncoghlan, @abalkin, @vstinner
Superseder	bpo-10435: Document unicode C-API in reST

^{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 2010-11-16.16:23:15.451>
created_at = <Date 2010-05-07.16:48:39.894>
labels = ['docs']
title = 'Py_UNICODE_* functions are undocumented'
updated_at = <Date 2010-11-16.16:23:15.449>
user = 'https://bugs.python.org/stutzbach'

bugs.python.org fields:

activity = <Date 2010-11-16.16:23:15.449>
actor = 'belopolsky'
assignee = 'docs@python'
closed = True
closed_date = <Date 2010-11-16.16:23:15.451>
closer = 'belopolsky'
components = ['Documentation']
creation = <Date 2010-05-07.16:48:39.894>
creator = 'stutzbach'
dependencies = []
files = []
hgrepos = []
issue_num = 8649
keywords = []
message_count = 4.0
messages = ['105214', '105732', '115435', '121303']
nosy_count = 6.0
nosy_names = ['terry.reedy', 'ncoghlan', 'belopolsky', 'vstinner', 'stutzbach', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = 'duplicate'
stage = 'needs patch'
status = 'closed'
superseder = '10435'
type = None
url = 'https://bugs.python.org/issue8649'
versions = ['Python 2.6', 'Python 3.1', 'Python 2.7', 'Python 3.2']

[stutzbach]

Python provides several functions for manipulating raw Py_UNICODE strings, but they aren't documented. Below are their signatures.

PyAPI_FUNC(size_t) Py_UNICODE_strlen(const Py_UNICODE *u);

PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strcpy(
    Py_UNICODE *s1, const Py_UNICODE *s2);

PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strncpy(
    Py_UNICODE *s1, const Py_UNICODE *s2, size_t n);

PyAPI_FUNC(int) Py_UNICODE_strcmp(
    const Py_UNICODE *s1, const Py_UNICODE *s2);

PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strchr(
    const Py_UNICODE *s, Py_UNICODE c
    );

[terryjreedy]

If, for this and your previous two issues, you could add a suggestion as to precisely where you would make an addition and what minimally adequate text you would add (even unformatted ascii text in a message) that is consistent with surrounding style, action would likely happen sooner.

[ncoghlan]

For this one, I suggest adding something to http://docs.python.org/dev/c-api/unicode.html#plain-py-unicode

[abalkin]

There are more undocumented functions in unicode.h. It makes sense to fix all of them in one patch. Closing this as superseded by bpo-10435.