Fixed #24994 -- Documented the expected type of settings.SECRET_KEY.

django · Dec 28, 2016 · 9e73487 · 9e73487
1 parent b52c730
commit 9e73487
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
@@ -2048,6 +2048,10 @@ unpredictable value.
 :djadmin:`django-admin startproject <startproject>` automatically adds a
 randomly-generated ``SECRET_KEY`` to each new project.
 
+Uses of the key shouldn't assume that it's text or bytes. Every use should go
+through :func:`~django.utils.encoding.force_text` or
+:func:`~django.utils.encoding.force_bytes` to convert it to the desired type.
+
 Django will refuse to start if :setting:`SECRET_KEY` is not set.
 
 .. warning::