Skip to content

Commit 9769026

Browse files
Add summary table to unicodedata.rst
1 parent fbd3b25 commit 9769026

1 file changed

Lines changed: 40 additions & 3 deletions

File tree

Doc/library/unicodedata.rst

Lines changed: 40 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,52 @@ this database is compiled from the `UCD version 17.0.0
1818

1919
The module uses the same names and symbols as defined by Unicode
2020
Standard Annex #44, `"Unicode Character Database"
21-
<https://www.unicode.org/reports/tr44/>`_. It defines the
22-
following functions:
21+
<https://www.unicode.org/reports/tr44/>`_.
2322

2423
.. seealso::
2524

2625
The :ref:`unicode-howto` for more information about Unicode and how to use
2726
this module.
2827

2928

29+
============================================================ ===========================================================
30+
**Lookup**
31+
-------------------------------------------------------------------------------------------------------------------------
32+
:func:`lookup(name) <lookup>` Look up character by name
33+
:func:`name(chr) <name>` Return the name assigned to a character
34+
35+
**Numeric values**
36+
-------------------------------------------------------------------------------------------------------------------------
37+
:func:`decimal(chr) <decimal>` Decimal value of a character
38+
:func:`digit(chr) <digit>` Digit value of a character
39+
:func:`numeric(chr) <numeric>` Numeric value of a character
40+
41+
**Properties**
42+
-------------------------------------------------------------------------------------------------------------------------
43+
:func:`bidirectional(chr) <bidirectional>` Bidirectional class of a character
44+
:func:`block(chr) <block>` Unicode block of a character
45+
:func:`category(chr) <category>` General category of a character
46+
:func:`combining(chr) <combining>` Canonical combining class of a character
47+
:func:`decomposition(chr) <decomposition>` Character decomposition mapping
48+
:func:`east_asian_width(chr) <east_asian_width>` East Asian width of a character
49+
:func:`extended_pictographic(chr) <extended_pictographic>` Check if a character has the Extended_Pictographic property
50+
:func:`grapheme_cluster_break(chr) <grapheme_cluster_break>` Grapheme_Cluster_Break property of a character
51+
:func:`indic_conjunct_break(chr) <indic_conjunct_break>` Indic_Conjunct_Break property of a character
52+
:func:`isxidcontinue(chr) <isxidcontinue>` Check if a character is a valid identifier continuation
53+
:func:`isxidstart(chr) <isxidstart>` Check if a character is a valid identifier start
54+
:func:`mirrored(chr) <mirrored>` Mirrored property of a character
55+
56+
**Normalization**
57+
-------------------------------------------------------------------------------------------------------------------------
58+
:func:`normalize(form, unistr) <normalize>` Return the normalized form of a string
59+
:func:`is_normalized(form, unistr) <is_normalized>` Check if a Unicode string is normalized
60+
61+
**Text segmentation**
62+
-------------------------------------------------------------------------------------------------------------------------
63+
:func:`iter_graphemes(unistr) <iter_graphemes>` Iterate over grapheme clusters in a string
64+
============================================================ ===========================================================
65+
66+
3067
.. function:: lookup(name, /)
3168

3269
Look up character by name. If a character with the given name is found, return
@@ -273,7 +310,7 @@ following functions:
273310
.. versionadded:: 3.15
274311

275312

276-
In addition, the module exposes the following constant:
313+
In addition, the module exposes the following constants:
277314

278315
.. data:: unidata_version
279316

0 commit comments

Comments
 (0)