summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2013-07-03 08:44:03 -0400
committerTim Graham <timograham@gmail.com>2013-07-03 08:46:05 -0400
commitb36f55c5a5bc7e3dac8a811973c7f7ad1c92d7c5 (patch)
treeae95060b3129f9516f54177adf67c7c0d1936656 /docs
parent5ecdf0eb9ccd47c102deb873a242ed40d1cf45cd (diff)
[1.6.x] Fixed #20691 -- Added a note for __str__() vs. __unicode__() and Python 3.
Thanks garrison for the suggestion. Backport of 8a679386c3 from master.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/unicode.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/ref/unicode.txt b/docs/ref/unicode.txt
index e5074285e4..c9534c12c9 100644
--- a/docs/ref/unicode.txt
+++ b/docs/ref/unicode.txt
@@ -240,6 +240,13 @@ Django will convert it to Unicode when it needs to.
Choosing between ``__str__()`` and ``__unicode__()``
----------------------------------------------------
+.. note::
+
+ If you are on Python 3, you can skip this section because you'll always
+ create ``__str__()`` rather than ``__unicode__()``. If you'd like
+ compatibility with Python 2, you can decorate your model class with
+ :func:`~django.utils.encoding.python_2_unicode_compatible`.
+
One consequence of using Unicode by default is that you have to take some care
when printing data from the model.