gh-151948：Fix all Sphinx reference warnings in Doc/library/select.rst - #151957
gh-151948：Fix all Sphinx reference warnings in Doc/library/select.rst#151957lpyu001 wants to merge 5 commits into
Doc/library/select.rst#151957Conversation
Documentation build overview
221 files changed ·
|
StanFromIreland
left a comment
StanFromIreland
left a comment
There was a problem hiding this comment.
We don't want to just remove the references, we want to fix them.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase And if you don't make the requested changes, you will be put in the comfy chair! |
I've modified it.pls review again |
| :const:`POLLPRI`, and :const:`POLLOUT`, described in the table above. If not | ||
| specified, the default value used will check for all 3 types of events. | ||
|
|
||
| +-------------------+-------------------------------------------+ |
lpyu001
changed the title
Doc/library/select.rst
|
I have made the requested changes; please review again |
|
Thanks for making the requested changes! @StanFromIreland: please review the changes made to this pull request. |
|
when the table remains inside the poll.register() directive, Sphinx records the first entry with the HTML ID select.poll.POLLIN, it creates an incorrect permalink and intersphinx inventory entry for POLLIN
|
|
Sorry, I replied to the question earlier, but I forgot to click “Submit review”, so the comment remained pending. |
|
Additionally, Sphinx omits the current context prefix from the displayed signature, so it shows only POLLIN, making it inconsistent with the other constants. |
StanFromIreland
left a comment
StanFromIreland
left a comment
There was a problem hiding this comment.
Aargh, sorry, I had this in pending all along!
| .. method:: kqueue.control(changelist, max_events[, timeout]) | ||
|
|
||
| Low level interface to kevent | ||
| Low level interface to kevent, returning a list of events. |
There was a problem hiding this comment.
| Low level interface to kevent, returning a list of events. | |
| Low level interface to kevent, returning a list of :ref:`kevent <kevent-objects>` | |
| objects. |
| | Constant | Meaning | | ||
| +============================+============================================+ | ||
| | :const:`KQ_NOTE_LOWAT` | Low water mark of a socket buffer. | | ||
| | .. data:: KQ_NOTE_LOWAT | Low water mark of a socket buffer. | |
There was a problem hiding this comment.
This one, and only this one, for some Sphinx reason, is in the attributes scope.
We can work around this (here and under the other attributes) by resetting to the module scope:
.. currentmodule:: select3 participants
Doc/library/select.rst#151948