Datamodel: Add headings to the standard type hierarchy

[AA-Turner]

I was looking to resolve reference warnings in the datamodel documentation, and noticed that the entire The standard type hierarchy section is comprised of definition lists. This makes it fairly hard to navigate via the sidebar, with three levels of nested indentation.

Each commit in this PR is a discrete step:

• Add sub-headings
• Remove level one indentation
• Add sub-sub-headings
• Remove level two indentation
• Add sub-sub-sub-headings
• Remove level three indentation
• Move two notes that were after their sub-sub-sub-sections to the relevant sub-sub-section
• Reword the two aforementioned notes

This is a preparatory PR for future improvements, but I think one that stands alone as an improvement to navigation. I imagine backports will need to be done manually due to changes in the datamodel between 3.11-3.13, happy to handle them.

A

---

📚 Documentation preview 📚: https://cpython-previews--108146.org.readthedocs.build/en/108146/reference/datamodel.html

[erlend-aasland]

I wonder if it would make sense to keep the definition lists for the innermost (sub-sub-sub) sections (that is, revert commit b6f31b9 and 3b3f580).

[AA-Turner]

Fine by me!

[erlend-aasland]

Hm, it looks like the two intrinsic set types should also be a definition list. Also, I find it strange that "Notes on using __slots__" is a sub-sub-sub-section. Would it not fit better as a bullet list in the parent sub-sub-section?

[AA-Turner]

Hm, it looks like the two intrinsic set types should also be a definition list.

No strong opinion here, so made them definition lists.

Also, I find it strange that "Notes on using slots" is a sub-sub-sub-section. Would it not fit better as a bullet list in the parent sub-sub-section?

A sub-sub-sub-sub-section, even! I'll open a new PR for Notes on using slots, this one is only intended to look at section 3.2 (the standard type hierarchy). Update: see #108400.

A

[erlend-aasland]

@hugovk, are you ok with this change?

[hugovk]

Fine by me, no strong opinion, but more linkable things in long pages is helpful. Thanks!

[hugovk]

One little unrelated suggestion we could lump in here, we could add some formatting to "(type[, value[, traceback]])" at the end of:

But not essential!

[erlend-aasland]

One little unrelated suggestion we could lump in here, we could add some formatting to "(type[, value[, traceback]])" at the end of [...]

I'd prefer this PR to only restructure the file but keep the content unchanged :)

[miss-islington]

Thanks @AA-Turner for the PR, and @erlend-aasland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

[miss-islington]

Sorry, @AA-Turner and @erlend-aasland, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 2b7bff0655a4caf51cd1a9e5bf85b3b96dd031c9 3.11

[bedevere-bot]

GH-108477 is a backport of this pull request to the 3.12 branch.

[miss-islington]

Thanks @AA-Turner for the PR, and @erlend-aasland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

[miss-islington]

Sorry @AA-Turner and @erlend-aasland, I had trouble checking out the 3.11 backport branch.
Please retry by removing and re-adding the "needs backport to 3.11" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 2b7bff0655a4caf51cd1a9e5bf85b3b96dd031c9 3.11

[miss-islington]

Thanks @AA-Turner for the PR, and @erlend-aasland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

[miss-islington]

Sorry @AA-Turner and @erlend-aasland, I had trouble checking out the 3.11 backport branch.
Please retry by removing and re-adding the "needs backport to 3.11" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 2b7bff0655a4caf51cd1a9e5bf85b3b96dd031c9 3.11

[bedevere-bot]

GH-108484 is a backport of this pull request to the 3.11 branch.