Skip to content

Commit 248f122

Browse files
authored
Add direct hyperlinks to Specification (#112)
Also adds Jamo to specification, from #111
1 parent 8ed7f2c commit 248f122

File tree

1 file changed

+33
-12
lines changed

1 file changed

+33
-12
lines changed

docs/specs.rst

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,35 @@ Width of -1
1212

1313
The following have a column width of -1 for function :func:`wcwidth.wcwidth`
1414

15-
- C0 control characters (U+001 through U+01F).
16-
- C1 control characters and DEL (U+07F through U+0A0).
15+
- ``C0`` control characters (`U+0001`_` through `U+001F`_).
16+
- ``C1`` control characters and ``DEL`` (`U+007F`_ through `U+00A0`_).
1717

18-
If any character in sequence contains C0 or C1 control characters, the final
18+
If any character in sequence contains ``C0`` or ``C1`` control characters, the final
1919
return value of of :func:`wcwidth.wcswidth` is -1.
2020

2121
Width of 0
2222
----------
2323

24-
Any characters defined by category codes in DerivedGeneralCategory txt files:
24+
Any characters defined by category codes in `DerivedGeneralCategory.txt`_ files:
2525

2626
- 'Me': Enclosing Combining Mark, aprox. 13 characters.
2727
- 'Mn': Nonspacing Combining Mark, aprox. 1,839 characters.
2828
- 'Mc': Spacing Mark, aprox. 443 characters.
2929
- 'Cf': Format control character, aprox. 161 characters.
30-
- 'Zl': U+2028 LINE SEPARATOR only
31-
- 'Zp': U+2029 PARAGRAPH SEPARATOR only
30+
- 'Zl': `U+2028`_ LINE SEPARATOR only
31+
- 'Zp': `U+2029`_ PARAGRAPH SEPARATOR only
3232
- 'Sk': Modifier Symbol, aprox. 4 characters of only those where phrase
3333
``'EMOJI MODIFIER'`` is present in comment of unicode data file.
3434

35-
The NULL character (``U+0000``).
35+
The NULL character (`U+0000`_).
3636

37-
Any character following a ZWJ (``U+200D``) when in sequence by
37+
Any character following ZWJ (`U+200D`_) when in sequence by
3838
function :func:`wcwidth.wcswidth`.
3939

40+
Hangul Jamo Jungseong and "Extended-B" code blocks, `U+1160`_ through
41+
`U+11FF`_ and `U+D7B0`_ through `U+D7FF`_.
42+
43+
4044
Width of 1
4145
----------
4246

@@ -47,12 +51,29 @@ Width of 2
4751
----------
4852

4953
Any character defined by East Asian Fullwidth (``F``) or Wide (``W``)
50-
properties in EastAsianWidth txt files, except those that are defined by the
54+
properties in `EastAsianWidth.txt`_ files, except those that are defined by the
5155
Category codes of Nonspacing Mark (``Mn``) and Spacing Mark (``Mc``).
5256

5357
Any characters of Modifier Symbol category, ``'Sk'`` where ``'FULLWIDTH'`` is
5458
present in comment of unicode data file, aprox. 3 characters.
5559

56-
Any character in sequence with U+FE0F (Variation Selector 16) defined by
57-
Emoji Variation Sequences txt as ``emoji style``.
58-
60+
Any character in sequence with `U+FE0F`_ (Variation Selector 16) defined by
61+
`emoji-variation-sequences.txt`_ as ``emoji style``.
62+
63+
64+
.. _`U+0000`: https://codepoints.net/U+0000
65+
.. _`U+0001`: https://codepoints.net/U+0001
66+
.. _`U+001F`: https://codepoints.net/U+001F
67+
.. _`U+007F`: https://codepoints.net/U+007F
68+
.. _`U+00A0`: https://codepoints.net/U+00A0
69+
.. _`U+1160`: https://codepoints.net/U+1160
70+
.. _`U+11FF`: https://codepoints.net/U+11FF
71+
.. _`U+200D`: https://codepoints.net/U+200D
72+
.. _`U+2028`: https://codepoints.net/U+2028
73+
.. _`U+2029`: https://codepoints.net/U+2029
74+
.. _`U+D7B0`: https://codepoints.net/U+D7B0
75+
.. _`U+D7FF`: https://codepoints.net/U+D7FF
76+
.. _`U+FE0F`: https://codepoints.net/U+FE0F
77+
.. _`DerivedGeneralCategory.txt`: https://www.unicode.org/Public/UCD/latest/ucd/extracted/DerivedGeneralCategory.txt
78+
.. _`EastAsianWidth.txt`: https://www.unicode.org/Public/UCD/latest/ucd/EastAsianWidth.txt`
79+
.. _`emoji-variation-sequences.txt`: https://www.unicode.org/Public/UCD/latest/ucd/emoji/emoji-variation-sequences.txt

0 commit comments

Comments
 (0)