Skip to content

gh-101100: Fix broken xrefs in fcntl module doc#115691

Merged
willingc merged 7 commits intopython:mainfrom
smontanaro:doc-fcntl
Feb 25, 2024
Merged

gh-101100: Fix broken xrefs in fcntl module doc#115691
willingc merged 7 commits intopython:mainfrom
smontanaro:doc-fcntl

Conversation

@smontanaro
Copy link
Copy Markdown
Contributor

@smontanaro smontanaro commented Feb 19, 2024

A few changes:

  1. Links for fcntl, ioctl and flock system calls are suppressed. Sphinx only complained about some, but even if it catalogued these somehow, it would likely have been incorrect.
  2. Suppress all :const:LOCK_* refs. They appear nowhere else in the Python docs. Users should read the relevant Unix manpages.
  3. Convert EACCES an EAGAIN constant references to data references in the errno module.

I'm inclined to move the rather large set of :versionchanged: directives down near the bottom of the file, though for now I left them alone. Almost all of them just identify additions to the set of command constants, and are both platform- and Linux kernel-dependent. As such, they are probably going to be used infrequently. They aren't key to understanding how to use the module.


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

Loading
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.

5 participants