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

[Petr Viktorin]

Petr Viktorin  added the comment:

PEP 652 is now in, and with it a list of everything that *is* in the stable 
ABI: https://docs.python.org/3.10/c-api/stable.html#contents-of-limited-api

I'm closing the issue.

--
resolution:  -> fixed
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Petr Viktorin]

Petr Viktorin  added the comment:

PEP 652 is currently draft & it's discussed at 
https://discuss.python.org/t/pep-652-maintaining-the-stable-abi/6986

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Nicholas Sim]

Change by Nicholas Sim :


--
nosy: +nw0

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Petr Viktorin]

Petr Viktorin  added the comment:

The bigger problem is that currently, it's not clear what is limited API and 
what is not.

I am working to propose a PEP to fix this. It will also cover documentation: 
https://discuss.python.org/t/pre-pep-maintaining-the-stable-abi/6986

--
nosy: +petr.viktorin

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Roundup Robot]

Change by Roundup Robot :


--
nosy: +python-dev
nosy_count: 3.0 -> 4.0
pull_requests: +22089
stage:  -> patch review
pull_request: https://github.com/python/cpython/pull/23185

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[STINNER Victor]

Change by STINNER Victor :


--
components: +C API

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Serhiy Storchaka]

Serhiy Storchaka  added the comment:

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?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Serhiy Storchaka]

New submission from Serhiy Storchaka:

>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.

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@python
components: Documentation
files: unicode-not-part-of-the-limited-api.patch
keywords: patch
messages: 284125
nosy: docs@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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com