[docs] [issue29086] Document C API that is not part of the limited API

Serhiy Storchaka report at bugs.python.org
Tue Dec 27 14:01:59 EST 2016

New submission from Serhiy Storchaka:

>From the documentation:


    In the C API documentation, API elements that are not part of the limited API are marked as "Not part of the limited API."

But they don't.

Following sample patch adds the notes to Unicode Objects and Codecs C API. I'm going to add them to all C API.

What are your though about formatting the note? Should it be before the description, after the description, but before the "deprecated" directive (as in the patch), or after the first paragraph of the description? Should it be on the separate line or be appended at the end of the previous paragraph, or starts the first paragraph (if before the description)? May be introduce a special directive for it?

assignee: docs at python
components: Documentation
files: unicode-not-part-of-the-limited-api.patch
keywords: patch
messages: 284125
nosy: docs at python, georg.brandl, serhiy.storchaka
priority: normal
severity: normal
status: open
title: Document C API that is not part of the limited API
type: enhancement
versions: Python 3.5, Python 3.6, Python 3.7
Added file: http://bugs.python.org/file46057/unicode-not-part-of-the-limited-api.patch

Python tracker <report at bugs.python.org>

More information about the docs mailing list