Skip to content

[C API] Add a banner to the C API documentation to recommend tools #133678

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.

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

Open
vstinner opened this issue May 8, 2025 · 3 comments
Open

[C API] Add a banner to the C API documentation to recommend tools #133678

vstinner opened this issue May 8, 2025 · 3 comments
Labels
docs Documentation in the Doc dir topic-C-API type-feature A feature request or enhancement

Comments

@vstinner
Copy link
Member

vstinner commented May 8, 2025

I propose adding a banner to all C API documentation pages to recommend using 3rd party tools, rather than using directly the C API.

See the discussion on HPy: https://discuss.python.org/t/c-api-working-group-and-plan-to-get-a-python-c-api-compatible-with-alternative-python-implementations/89477/41

Linked PRs

@encukou
Copy link
Member

encukou commented May 9, 2025

-1. I think CPython should have a usable and stable C API for all stakeholders, and a list of a few blessed users goes against that goal.

Extend the current list with the ideas here, but please don't add a new one and don't link to it aggressively from every page.

@vstinner
Copy link
Member Author

vstinner commented May 9, 2025

-1. I think CPython should have a usable and stable C API for all stakeholders,

The banner doesn't change anything to the C API maintenance. It will remain the same.

and a list of a few blessed users goes against that goal.

Do you mean that the list is too short? Or do you mean that developers should be able/"allowed" to write C extensions directly with the C API?

Extend the current list with the ideas here, but please don't add a new one and don't link to it aggressively from every page.

Why do you think that it's aggressive? Can you propose a different phrasing to make it not aggressive?

@encukou
Copy link
Member

encukou commented May 9, 2025

The banner doesn't change anything to the C API maintenance. It will remain the same.

What's the motivation for this change, then?

Do you mean that the list is too short? Or do you mean that developers should be able/"allowed" to write C extensions directly with the C API?

Both.

Why do you think that it's aggressive?

It's on every page of the reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir topic-C-API type-feature A feature request or enhancement
Projects
Status: Todo
Development

No branches or pull requests

3 participants