python / cpython

The Python programming language
https://www.python.org
Other
63.59k stars 30.46k forks source link

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

Open junkmd opened 17 hours ago

junkmd commented 17 hours ago

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/