summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code/coding-style.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/internals/contributing/writing-code/coding-style.txt')
-rw-r--r--docs/internals/contributing/writing-code/coding-style.txt17
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt
index d227e04ba0..6871d43d7b 100644
--- a/docs/internals/contributing/writing-code/coding-style.txt
+++ b/docs/internals/contributing/writing-code/coding-style.txt
@@ -298,16 +298,23 @@ Model style
* Any custom methods
* If ``choices`` is defined for a given model field, define each choice as a
- list of tuples, with an all-uppercase name as a class attribute on the model.
+ mapping, with an all-uppercase name as a class attribute on the model.
Example::
class MyModel(models.Model):
DIRECTION_UP = "U"
DIRECTION_DOWN = "D"
- DIRECTION_CHOICES = [
- (DIRECTION_UP, "Up"),
- (DIRECTION_DOWN, "Down"),
- ]
+ DIRECTION_CHOICES = {
+ DIRECTION_UP: "Up",
+ DIRECTION_DOWN: "Down",
+ }
+
+ Alternatively, consider using :ref:`field-choices-enum-types`::
+
+ class MyModel(models.Model):
+ class Direction(models.TextChoices):
+ UP = U, "Up"
+ DOWN = D, "Down"
Use of ``django.conf.settings``
===============================