Skip to content

Add summary table to the unicodedata doc#149957

Open
StanFromIreland wants to merge 2 commits into
python:mainfrom
StanFromIreland:unicodedata-summary
Open

Add summary table to the unicodedata doc#149957
StanFromIreland wants to merge 2 commits into
python:mainfrom
StanFromIreland:unicodedata-summary

Conversation

@StanFromIreland
Copy link
Copy Markdown
Member

This was suggested by @merwok some time ago (I can't remember where). The patch adds a little summary table like the one in the math module docs. I however, excluded the constants, as most people don't care about them anyway.

@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 17, 2026

Documentation build overview

📚 cpython-previews | 🛠️ Build #32727141 | 📁 Comparing 889fb5f against main (acefff9)

  🔍 Preview build  

1 file changed
± library/unicodedata.html

Copy link
Copy Markdown
Contributor

@clin1234 clin1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@serhiy-storchaka
Copy link
Copy Markdown
Member

I am not a great fun of such tables. They take up the entire screen, and you have to scroll through them before getting to the documentation for specific functions. Can we add the list of names to the left panel?

Copy link
Copy Markdown
Member

@malemburg malemburg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@StanFromIreland
Copy link
Copy Markdown
Member Author

Can we add the list of names to the left panel?

I don't think that solves the original problem, they do not provide any summary/overview of what all the functions do. Additionally, I agree it would be good, however it is and isn't possible. It would have to be enabled doc-wide, which we have done before (91ddde4), but have had to revert (c9d2bc6) because it was too disruptive.

@serhiy-storchaka
Copy link
Copy Markdown
Member

Well, I do not actively oppose this. This module is pretty small. But in some cases it seems excessive.

@StanFromIreland
Copy link
Copy Markdown
Member Author

StanFromIreland commented May 18, 2026

If it were graphlib, I'd agree ;-) In this case I think it is useful, it is a slightly messy jumble of various functions. How opposed are you in this specific case?

@StanFromIreland StanFromIreland added the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label May 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting merge docs Documentation in the Doc dir needs backport to 3.15 pre-release feature fixes, bugs and security fixes skip issue skip news topic-unicode

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

5 participants