Skip to content

Commit

Permalink
[2.2.x] Changed tuple Mate.unique_together/permissions to lists in docs.
Browse files Browse the repository at this point in the history
Backport of 0c91625 from master
  • Loading branch information
spookylukey authored and felixxm committed Apr 24, 2019
1 parent 88bf635 commit 4641655
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
12 changes: 6 additions & 6 deletions docs/ref/models/options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)``.
Expand Down Expand Up @@ -412,17 +412,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
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/auth/customizing.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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 <migrate>` (the function that creates permissions
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/auth/default.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 3 additions & 3 deletions docs/topics/serialization.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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::

Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 4641655

Please sign in to comment.