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.

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

Replace :platform: with .. availability:: in socket.ioctl doc. #127122

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

junkmd
Copy link
Contributor

@junkmd junkmd commented Nov 21, 2024

When documenting the platforms on which an API is available, it was clarified in the discussion on gh-126686 that ".. availability:: is generally the correct one to use" rather than :platform:.

I was a bit confused after seeing both being used in the socket documentation, and I’d like to ensure that similar confusion doesn’t arise in the future.


📚 Documentation preview 📚: https://cpython-previews--127122.org.readthedocs.build/

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting review docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

1 participant