GeezerVison

Documentation build overview

📚 cpython-previews | 🛠️ Build #34564884 | 📁 Comparing 50a59b2 against main (6920036)

  🔍 Preview build  

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 I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

And if you don't make the requested changes, you will be put in the comfy chair!

We don't want to just remove the references, we want to fix them.

I've modified it.pls review again

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

file:///C:/Users/syhsp/Desktop/library/select.html#select.poll.POLLIN @hugovk

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.

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.

yes .. currentmodule:: only sets py:module, not py:class — with the table left inside the attribute body I still got select.kevent.KQ_NOTE_LOWAT. Dedenting ends the attribute body, which puts the constants back at module scope. I dedented the tables too so they don't render inside a blockquote

Oh I see, is there no other way to avoid this?

The current approach is the only one I found that works, and I think the current layout also follows existing documentation conventions.

Several modules already document constants exactly like this

• curses.rst, "Attributes" (

  cpython/Doc/library/curses.rst

  Lines 2330 to 2344 in 7f52444

  	Some constants are available to specify character cell attributes.
  	The exact constants available are system dependent.
  	.. _curses-wa-constants:
  	+------------------------+-------------------------+------------------------------------------+
  	| Attribute | Wide attribute | Meaning |
  	+========================+=========================+==========================================+
  	| .. data:: A_ALTCHARSET | .. data:: WA_ALTCHARSET | Alternate character set mode |
  	+------------------------+-------------------------+------------------------------------------+
  	| .. data:: A_BLINK | .. data:: WA_BLINK | Blink mode |
  	+------------------------+-------------------------+------------------------------------------+
  	| .. data:: A_BOLD | .. data:: WA_BOLD | Bold mode |
  	+------------------------+-------------------------+------------------------------------------+
  	| .. data:: A_DIM | .. data:: WA_DIM | Dim mode |

  )
• curses.ascii.rst, control characters (

  cpython/Doc/library/curses.ascii.rst

  Lines 12 to 24 in 7f52444

  	functions to test membership in various ASCII character classes. The constants
  	supplied are names for control characters as follows:
  	+---------------+----------------------------------------------+
  	| Name | Meaning |
  	+===============+==============================================+
  	| .. data:: NUL | |
  	+---------------+----------------------------------------------+
  	| .. data:: SOH | Start of heading, console interrupt |
  	+---------------+----------------------------------------------+
  	| .. data:: STX | Start of text |
  	+---------------+----------------------------------------------+
  	| .. data:: ETX | End of text |

  )
• xml.dom.rst, exception codes (

  cpython/Doc/library/xml.dom.rst

  Lines 1432 to 1444 in 7f52444

  	The exception codes defined in the DOM recommendation map to the exceptions
  	described above according to this table:
  	+---------------------------------------+---------------------------------+
  	| Constant | Exception |
  	+=======================================+=================================+
  	| .. data:: DOMSTRING_SIZE_ERR | :exc:`DomstringSizeErr` |
  	+---------------------------------------+---------------------------------+
  	| .. data:: HIERARCHY_REQUEST_ERR | :exc:`HierarchyRequestErr` |
  	+---------------------------------------+---------------------------------+
  	| .. data:: INDEX_SIZE_ERR | :exc:`IndexSizeErr` |
  	+---------------------------------------+---------------------------------+
  	| .. data:: INUSE_ATTRIBUTE_ERR | :exc:`InuseAttributeErr` |

  )
• decimal.rst, C module constants (

  cpython/Doc/library/decimal.rst

  Lines 1603 to 1615 in 7f52444

  	The following constants are only relevant for the C module. They
  	are also included in the pure Python version for compatibility.
  	+---------------------------------+---------------------+-------------------------------+
  	| | 32-bit | 64-bit |
  	+=================================+=====================+===============================+
  	| .. data:: MAX_PREC | ``425000000`` | ``999999999999999999`` |
  	+---------------------------------+---------------------+-------------------------------+
  	| .. data:: MAX_EMAX | ``425000000`` | ``999999999999999999`` |
  	+---------------------------------+---------------------+-------------------------------+
  	| .. data:: MIN_EMIN | ``-425000000`` | ``-999999999999999999`` |
  	+---------------------------------+---------------------+-------------------------------+
  	| .. data:: MIN_ETINY | ``-849999999`` | ``-1999999999999999997`` |

  )