diff options
| author | Mark Dickinson <dickinsm@gmail.com> | 2009-02-01 14:18:10 (GMT) |
|---|---|---|
| committer | Mark Dickinson <dickinsm@gmail.com> | 2009-02-01 14:18:10 (GMT) |
| commit | c48d83402687c0c5d6da1c7bb1a677208effa35e (patch) | |
| tree | 3bc0e90855d9d77d2355e0e477c354d765db12b0 /Doc/library/locale.rst | |
| parent | c008a176afdef8cb7afc0e48a8fb306f986964e8 (diff) | |
| download | cpython-c48d83402687c0c5d6da1c7bb1a677208effa35e.zip cpython-c48d83402687c0c5d6da1c7bb1a677208effa35e.tar.gz cpython-c48d83402687c0c5d6da1c7bb1a677208effa35e.tar.bz2 | |
Issue #1717: documentation fixes related to the cmp removal.
Diffstat (limited to 'Doc/library/locale.rst')
| -rw-r--r-- | Doc/library/locale.rst | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/Doc/library/locale.rst b/Doc/library/locale.rst index 381107e..da3a843 100644 --- a/Doc/library/locale.rst +++ b/Doc/library/locale.rst @@ -225,12 +225,11 @@ The :mod:`locale` module defines the following exception and functions: .. function:: strxfrm(string) - .. index:: builtin: cmp - - Transforms a string to one that can be used for the built-in function - :func:`cmp`, and still returns locale-aware results. This function can be used - when the same string is compared repeatedly, e.g. when collating a sequence of - strings. + Transforms a string to one that can be used in locale-aware + comparisons. For example, ``strxfrm(s1) < strxfrm(s2)`` is + equivalent to ``strcoll(s1, s2) < 0``. This function can be used + when the same string is compared repeatedly, e.g. when collating a + sequence of strings. .. function:: format(format, val[, grouping[, monetary]]) |