Title: Document C API that is not part of the limited API
Type: enhancement Stage: patch review
Components: C API, Documentation Versions: Python 3.7, Python 3.6, Python 3.5
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, georg.brandl, python-dev, serhiy.storchaka
Priority: normal Keywords: patch

Created on 2016-12-27 19:01 by serhiy.storchaka, last changed 2020-11-06 22:17 by python-dev.

File name Uploaded Description Edit
unicode-not-part-of-the-limited-api.patch serhiy.storchaka, 2016-12-27 19:01 review
Pull Requests
URL Status Linked Edit
PR 23185 open python-dev, 2020-11-06 22:17
Messages (2)
msg284125 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2016-12-27 19:01
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?
msg309546 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2018-01-06 11:12
I have found that there is an option :stableabi: for C API elements. But it is not used in the documentation. Shouldn't we start to use it?
Date User Action Args
2020-11-06 22:17:46python-devsetnosy: + python-dev

pull_requests: + pull_request22089
stage: patch review
2020-06-25 09:47:45vstinnersetcomponents: + C API
2018-01-06 11:12:28serhiy.storchakasetmessages: + msg309546
2016-12-27 19:01:59serhiy.storchakacreate