From 9a93c1a394f4bab9f91f29005d9a042907e13de8 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Fri, 14 Apr 2017 08:05:58 -0400 Subject: [PATCH] [1.11.x] Fixed #28067 -- Clarified __str__() return type when using python_2_unicode_compatible(). Backport of 83cbb8d080299669de3569941a40789e5d32b009 from master --- docs/ref/utils.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/ref/utils.txt b/docs/ref/utils.txt index 18561781c1..6ab00cc9c7 100644 --- a/docs/ref/utils.txt +++ b/docs/ref/utils.txt @@ -199,7 +199,8 @@ The functions defined in this module share the following properties: Python 2. Under Python 3 it does nothing. To support Python 2 and 3 with a single code base, define a ``__str__`` - method returning text and apply this decorator to the class. + method returning text (use ``six.text_type()`` if you're doing some + casting) and apply this decorator to the class. .. function:: smart_text(s, encoding='utf-8', strings_only=False, errors='strict')