Skip to content

gh-91755: Remove doc of C API private refcount functions #92918

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

Merged
merged 1 commit into from
May 18, 2022
Merged

gh-91755: Remove doc of C API private refcount functions #92918

merged 1 commit into from
May 18, 2022

Conversation

vstinner
Copy link
Member

These functions should only be used by Python internals.

These functions should only be used by Python internals.
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting core review labels May 18, 2022
@vstinner
Copy link
Member Author

@erlend-aasland: What do you think of removing this documentation?

I don't want to backport this change, it's only for Python 3.12.

@erlend-aasland
Copy link
Contributor

AFAIK, we don't normally document private and internal API, so it looks sensible to me.

@vstinner vstinner merged commit e0477ae into python:main May 18, 2022
@vstinner vstinner deleted the doc_refcount branch May 18, 2022 12:09
@vstinner
Copy link
Member Author

If tomorrow Python would have a documentation for the "internal C API", I would be fine with documenting private and internal functions. But for now, I prefer to stick to only public C API functions.

Thanks for the review @erlend-aasland, I merged the PR.

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 skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants