[Python-Dev] Document C API that is not part of the limited API (original) (raw)
Serhiy Storchaka storchaka at gmail.com
Tue Dec 27 14:04:22 EST 2016
- Previous message (by thread): [Python-Dev] Merry Christmas to me, and Python users everywhere
- Next message (by thread): [Python-Dev] Document C API that is not part of the limited API
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
From the documentation:
https://docs.python.org/3/c-api/stable.html
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.
I prepared a sample patch that adds the notes to Unicode Objects and Codecs C API (http://bugs.python.org/issue29086). 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?
- Previous message (by thread): [Python-Dev] Merry Christmas to me, and Python users everywhere
- Next message (by thread): [Python-Dev] Document C API that is not part of the limited API
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]