Replace :platform: with .. availability:: in socket.ioctl doc. - #127122
Merged
encukou merged 1 commit intoNov 25, 2024
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
junkmd
force-pushed
the
socket_ioctl_availability
branch
from
4414b08 to
0c7def9
Compare
November 22, 2024 23:39
ebonnal
pushed a commit
to ebonnal/cpython
that referenced
this pull request
Jan 12, 2025
…ythonGH-127122) In `socket.ioctl`, `:platform:` -> `.. availability::`
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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/