[Python-checkins] cpython: Clarify ord() and chr() documentation

[nick.coghlan]

http://hg.python.org/cpython/rev/f0fb8ff9a82c
changeset:   92123:f0fb8ff9a82c
user:        Nick Coghlan <ncoghlan at gmail.com>
date:        Sun Aug 17 14:07:53 2014 +1000
summary:
  Clarify ord() and chr() documentation

files:
  Doc/library/functions.rst |  19 ++++++++++---------
  1 files changed, 10 insertions(+), 9 deletions(-)


diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -156,11 +156,13 @@
 
 .. 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 @@
       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])

-- 
Repository URL: http://hg.python.org/cpython