diff Include/unicodeobject.h @ 72554:2e9fb59a1484

PyUnicode_CHARACTER_SIZE(): add a reference to PyUnicode_KIND_SIZE()
author Victor Stinner <victor.stinner@haypocalc.com>
date Sat, 01 Oct 2011 02:39:37 +0200
parents c75b04996f54
children fc7d2c6db61b
line wrap: on
line diff
--- a/Include/unicodeobject.h	Sat Oct 01 02:14:59 2011 +0200
+++ b/Include/unicodeobject.h	Sat Oct 01 02:39:37 2011 +0200
@@ -338,7 +338,9 @@
 
 
 /* Return the number of bytes the string uses to represent single characters,
-   this can be 1, 2 or 4. */
+   this can be 1, 2 or 4.
+
+   See also PyUnicode_KIND_SIZE(). */
 #define PyUnicode_CHARACTER_SIZE(op) \
     (1 << (PyUnicode_KIND(op) - 1))
 
@@ -378,8 +380,9 @@
      _PyUnicode_NONCOMPACT_DATA(op))
 
 /* Compute (index * char_size) where char_size is 2 ** (kind - 1).
+   The index is a character index, the result is a size in bytes.
 
-   The index is a character index, the result is a size in bytes. */
+   See also PyUnicode_CHARACTER_SIZE(). */
 #define PyUnicode_KIND_SIZE(kind, index) ((index) << ((kind) - 1))
 
 /* In the access macros below, "kind" may be evaluated more than once.