Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document C API that is not part of the limited API #73272

Closed
serhiy-storchaka opened this issue Dec 27, 2016 · 5 comments
Closed

Document C API that is not part of the limited API #73272

serhiy-storchaka opened this issue Dec 27, 2016 · 5 comments
Labels
3.7 (EOL) end of life docs Documentation in the Doc dir topic-C-API type-feature A feature request or enhancement

Comments

@serhiy-storchaka
Copy link
Member

BPO 29086
Nosy @birkenfeld, @encukou, @serhiy-storchaka, @nw0
PRs
  • bpo-29086: Add stableabi option to Documentation #23185
    		•
    Files
  • unicode-not-part-of-the-limited-api.patch
    		•

    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 2021-06-01.14:49:53.293>
created_at = <Date 2016-12-27.19:01:58.968>
labels = ['expert-C-API', 'type-feature', '3.7', 'docs']
title = 'Document C API that is not part of the limited API'
updated_at = <Date 2021-06-01.14:49:53.293>
user = 'https://github.com/serhiy-storchaka'

    bugs.python.org fields:

    activity = <Date 2021-06-01.14:49:53.293>
actor = 'petr.viktorin'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-06-01.14:49:53.293>
closer = 'petr.viktorin'
components = ['Documentation', 'C API']
creation = <Date 2016-12-27.19:01:58.968>
creator = 'serhiy.storchaka'
dependencies = []
files = ['46057']
hgrepos = []
issue_num = 29086
keywords = ['patch']
message_count = 5.0
messages = ['284125', '309546', '386173', '387229', '394860']
nosy_count = 6.0
nosy_names = ['georg.brandl', 'petr.viktorin', 'docs@python', 'python-dev', 'serhiy.storchaka', 'nw0']
pr_nums = ['23185']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue29086'
versions = ['Python 3.5', 'Python 3.6', 'Python 3.7']
    @serhiy-storchaka
    Copy link
    Member 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.

    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?

    @serhiy-storchaka serhiy-storchaka added the 3.7 (EOL) end of life label Dec 27, 2016
    @serhiy-storchaka serhiy-storchaka added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Dec 27, 2016
    @serhiy-storchaka
    Copy link
    Member Author

    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?

    @encukou
    Copy link
    Member

    encukou commented Feb 2, 2021

    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

    @encukou
    Copy link
    Member

    encukou commented Feb 18, 2021

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

    @encukou
    Copy link
    Member

    encukou commented Jun 1, 2021

    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.

    @encukou encukou closed this as completed Jun 1, 2021
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.7 (EOL) end of life docs Documentation in the Doc dir topic-C-API type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @vstinner @encukou @serhiy-storchaka