Add summary table to the unicodedata doc (#149957)

This commit is contained in:
Stan Ulbrych 2026-05-20 16:04:10 +01:00 committed by GitHub
parent f621ba16b7
commit 87a879f4d0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -18,8 +18,7 @@ this database is compiled from the `UCD version 17.0.0
The module uses the same names and symbols as defined by Unicode
Standard Annex #44, `"Unicode Character Database"
<https://www.unicode.org/reports/tr44/>`_. It defines the
following functions:
<https://www.unicode.org/reports/tr44/>`_.
.. seealso::
@ -27,6 +26,44 @@ following functions:
this module.
============================================================ ===========================================================
**Lookup**
-------------------------------------------------------------------------------------------------------------------------
:func:`lookup(name) <lookup>` Look up character by name
:func:`name(chr) <name>` Return the name assigned to a character
**Numeric values**
-------------------------------------------------------------------------------------------------------------------------
:func:`decimal(chr) <decimal>` Decimal value of a character
:func:`digit(chr) <digit>` Digit value of a character
:func:`numeric(chr) <numeric>` Numeric value of a character
**Properties**
-------------------------------------------------------------------------------------------------------------------------
:func:`bidirectional(chr) <bidirectional>` Bidirectional class of a character
:func:`block(chr) <block>` Unicode block of a character
:func:`category(chr) <category>` General category of a character
:func:`combining(chr) <combining>` Canonical combining class of a character
:func:`decomposition(chr) <decomposition>` Character decomposition mapping
:func:`east_asian_width(chr) <east_asian_width>` East Asian width of a character
:func:`extended_pictographic(chr) <extended_pictographic>` Check if a character has the Extended_Pictographic property
:func:`grapheme_cluster_break(chr) <grapheme_cluster_break>` Grapheme_Cluster_Break property of a character
:func:`indic_conjunct_break(chr) <indic_conjunct_break>` Indic_Conjunct_Break property of a character
:func:`isxidcontinue(chr) <isxidcontinue>` Check if a character is a valid identifier continuation
:func:`isxidstart(chr) <isxidstart>` Check if a character is a valid identifier start
:func:`mirrored(chr) <mirrored>` Mirrored property of a character
**Normalization**
-------------------------------------------------------------------------------------------------------------------------
:func:`normalize(form, unistr) <normalize>` Return the normalized form of a string
:func:`is_normalized(form, unistr) <is_normalized>` Check if a Unicode string is normalized
**Text segmentation**
-------------------------------------------------------------------------------------------------------------------------
:func:`iter_graphemes(unistr) <iter_graphemes>` Iterate over grapheme clusters in a string
============================================================ ===========================================================
.. function:: lookup(name, /)
Look up character by name. If a character with the given name is found, return
@ -273,7 +310,7 @@ following functions:
.. versionadded:: 3.15
In addition, the module exposes the following constant:
In addition, the module exposes the following constants:
.. data:: unidata_version