]> granicus.if.org Git - python/commitdiff
Clarify ord() and chr() documentation
authorNick Coghlan <ncoghlan@gmail.com>
Sun, 17 Aug 2014 04:07:53 +0000 (14:07 +1000)
committerNick Coghlan <ncoghlan@gmail.com>
Sun, 17 Aug 2014 04:07:53 +0000 (14:07 +1000)
Doc/library/functions.rst

index 2a89ce451e2a460d58adfb78fb69fb7f066e74ac..45f9cf500ecb1c2144f1b0c305858fe5338df2f2 100644 (file)
@@ -156,11 +156,13 @@ are always available.  They are listed here in alphabetical order.
 
 .. function:: chr(i)
 
-   Return the string representing a character whose Unicode codepoint is the integer
-   *i*.  For example, ``chr(97)`` returns the string ``'a'``. This is the
-   inverse of :func:`ord`.  The valid range for the argument is from 0 through
-   1,114,111 (0x10FFFF in base 16).  :exc:`ValueError` will be raised if *i* is
-   outside that range.
+   Return the string representing a character whose Unicode codepoint is the
+   integer *i*.  For example, ``chr(97)`` returns the string ``'a'``, while
+   ``chr(12491)`` returns the string ``'ニ'``. This is the inverse of
+   :func:`ord`.
+
+   The valid range for the argument is from 0 through 1,114,111 (0x10FFFF in
+   base 16).  :exc:`ValueError` will be raised if *i* is outside that range.
 
 
 .. function:: classmethod(function)
@@ -1056,13 +1058,12 @@ are always available.  They are listed here in alphabetical order.
       The ``'U'`` mode.
 
 
-.. XXX works for bytes too, but should it?
 .. function:: ord(c)
 
    Given a string representing one Unicode character, return an integer
-   representing the Unicode code
-   point of that character.  For example, ``ord('a')`` returns the integer ``97``
-   and ``ord('\u2020')`` returns ``8224``.  This is the inverse of :func:`chr`.
+   representing the Unicode code point of that character.  For example,
+   ``ord('a')`` returns the integer ``97`` and ``ord('ニ')`` returns
+   ``12491``.  This is the inverse of :func:`chr`.
 
 
 .. function:: pow(x, y[, z])