From 0c916255eb4d94e06e123fafec93efdba45b1259 Mon Sep 17 00:00:00 2001 From: Luke Plant Date: Mon, 22 Apr 2019 09:31:08 +0300 Subject: [PATCH] Changed tuple Mate.unique_together/permissions to lists in docs. --- docs/ref/models/options.txt | 12 ++++++------ docs/topics/auth/customizing.txt | 4 ++-- docs/topics/auth/default.txt | 4 ++-- docs/topics/serialization.txt | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/ref/models/options.txt b/docs/ref/models/options.txt index d28cd3fe16d..6a50da51847 100644 --- a/docs/ref/models/options.txt +++ b/docs/ref/models/options.txt @@ -309,7 +309,7 @@ Django quotes column and table names behind the scenes. Add, change, delete, and view permissions are automatically created for each model. This example specifies an extra permission, ``can_deliver_pizzas``:: - permissions = (("can_deliver_pizzas", "Can deliver pizzas"),) + permissions = [('can_deliver_pizzas', 'Can deliver pizzas')] This is a list or tuple of 2-tuples in the format ``(permission_code, human_readable_permission_name)``. @@ -408,17 +408,17 @@ Django quotes column and table names behind the scenes. Sets of field names that, taken together, must be unique:: - unique_together = (("driver", "restaurant"),) + unique_together = [['driver', 'restaurant']] - This is a tuple of tuples that must be unique when considered together. + This is a list of lists that must be unique when considered together. It's used in the Django admin and is enforced at the database level (i.e., the appropriate ``UNIQUE`` statements are included in the ``CREATE TABLE`` statement). - For convenience, unique_together can be a single tuple when dealing with a single - set of fields:: + For convenience, ``unique_together`` can be a single list when dealing with + a single set of fields:: - unique_together = ("driver", "restaurant") + unique_together = ['driver', 'restaurant'] A :class:`~django.db.models.ManyToManyField` cannot be included in unique_together. (It's not clear what that would even mean!) If you diff --git a/docs/topics/auth/customizing.txt b/docs/topics/auth/customizing.txt index 87988873a4f..5c01067a756 100644 --- a/docs/topics/auth/customizing.txt +++ b/docs/topics/auth/customizing.txt @@ -277,10 +277,10 @@ can or cannot do with ``Task`` instances, specific to your application:: class Task(models.Model): ... class Meta: - permissions = ( + permissions = [ ("change_task_status", "Can change the status of tasks"), ("close_task", "Can remove a task by setting its status as closed"), - ) + ] The only thing this does is create those extra permissions when you run :djadmin:`manage.py migrate ` (the function that creates permissions diff --git a/docs/topics/auth/default.txt b/docs/topics/auth/default.txt index fc2b00f1095..d7c0732794a 100644 --- a/docs/topics/auth/default.txt +++ b/docs/topics/auth/default.txt @@ -328,12 +328,12 @@ inherit the permissions of the concrete model they subclass:: class Person(models.Model): class Meta: - permissions = (('can_eat_pizzas', 'Can eat pizzas'),) + permissions = [('can_eat_pizzas', 'Can eat pizzas')] class Student(Person): class Meta: proxy = True - permissions = (('can_deliver_pizzas', 'Can deliver pizzas'),) + permissions = [('can_deliver_pizzas', 'Can deliver pizzas')] >>> # Fetch the content type for the proxy model. >>> content_type = ContentType.objects.get_for_model(Student, for_concrete_model=False) diff --git a/docs/topics/serialization.txt b/docs/topics/serialization.txt index e4e92fca43f..11d07bf301a 100644 --- a/docs/topics/serialization.txt +++ b/docs/topics/serialization.txt @@ -367,7 +367,7 @@ Consider the following two models:: birthdate = models.DateField() class Meta: - unique_together = (('first_name', 'last_name'),) + unique_together = [['first_name', 'last_name']] class Book(models.Model): name = models.CharField(max_length=100) @@ -411,7 +411,7 @@ name:: objects = PersonManager() class Meta: - unique_together = (('first_name', 'last_name'),) + unique_together = [['first_name', 'last_name']] Now books can use that natural key to refer to ``Person`` objects:: @@ -459,7 +459,7 @@ Firstly, you need to add another method -- this time to the model itself:: objects = PersonManager() class Meta: - unique_together = (('first_name', 'last_name'),) + unique_together = [['first_name', 'last_name']] def natural_key(self): return (self.first_name, self.last_name)