Skip to content

Commit 302a64a

Browse files
committed
Updated base classes in documentation
1 parent bb11253 commit 302a64a

File tree

2 files changed

+19
-18
lines changed

2 files changed

+19
-18
lines changed

README.rst

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -146,14 +146,14 @@ At the moment, it is not possible to select two languages to be marked as requir
146146

147147
.. code-block:: python
148148
149-
class MyModel(models.Model):
149+
class MyModel(LocalizedModel):
150150
title = LocalizedField(required=True)
151151
152152
* Make all languages optional:
153153

154154
.. code-block:: python
155155
156-
class MyModel(models.Model):
156+
class MyModel(LocalizedModel):
157157
title = LocalizedField(null=True)
158158
159159
**Uniqueness**
@@ -164,7 +164,7 @@ By default the values stored in a ``LocalizedField`` are *not unique*. You can e
164164

165165
.. code-block:: python
166166
167-
class MyModel(models.Model):
167+
class MyModel(LocalizedModel):
168168
title = LocalizedField(uniqueness=['en', 'ro'])
169169
170170
* Enforce uniqueness for **all** languages:
@@ -173,14 +173,14 @@ By default the values stored in a ``LocalizedField`` are *not unique*. You can e
173173
174174
from localized_fields import get_language_codes
175175
176-
class MyModel(models.Model):
176+
class MyModel(LocalizedModel):
177177
title = LocalizedField(uniqueness=get_language_codes())
178178
179179
* Enforce uniqueness for one ore more languages **together** (similar to Django's ``unique_together``):
180180

181181
.. code-block:: python
182182
183-
class MyModel(models.Model):
183+
class MyModel(LocalizedModel):
184184
title = LocalizedField(uniqueness=[('en', 'ro')])
185185
186186
* Enforce uniqueness for **all** languages **together**:
@@ -189,7 +189,7 @@ By default the values stored in a ``LocalizedField`` are *not unique*. You can e
189189
190190
from localized_fields import get_language_codes
191191
192-
class MyModel(models.Model):
192+
class MyModel(LocalizedModel):
193193
title = LocalizedField(uniqueness=[(*get_language_codes())])
194194
195195
@@ -203,11 +203,12 @@ Besides ``LocalizedField``, there's also:
203203

204204
.. code-block:: python
205205
206-
from localized_fields.models import LocalizedModel
207-
from localized_fields.fields import (LocalizedField,
208-
LocalizedUniqueSlugField)
206+
from localized_fields import (LocalizedModel,
207+
AtomicSlugRetryMixin,
208+
LocalizedField,
209+
LocalizedUniqueSlugField)
209210
210-
class MyModel(LocalizedModel):
211+
class MyModel(AtomicSlugRetryMixin, LocalizedModel):
211212
title = LocalizedField()
212213
slug = LocalizedUniqueSlugField(populate_from='title')
213214
@@ -218,9 +219,9 @@ Besides ``LocalizedField``, there's also:
218219

219220
.. code-block:: python
220221
221-
from localized_fields.models import LocalizedModel
222-
from localized_fields.fields import (LocalizedField,
223-
LocalizedAutoSlugField)
222+
from localized_fields import (LocalizedModel,
223+
LocalizedField,
224+
LocalizedUniqueSlugField)
224225
225226
class MyModel(LocalizedModel):
226227
title = LocalizedField()
@@ -236,9 +237,9 @@ Besides ``LocalizedField``, there's also:
236237

237238
.. code-block:: python
238239
239-
from localized_fields.models import LocalizedModel
240-
from localized_fields.fields import (LocalizedField,
241-
LocalizedBleachField)
240+
from localized_fields import (LocalizedModel,
241+
LocalizedField,
242+
LocalizedBleachField)
242243
243244
class MyModel(LocalizedModel):
244245
title = LocalizedField()

localized_fields/fields/localized_uniqueslug_field.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ def __init__(self, *args, **kwargs):
2929
self.populate_from = kwargs.pop('populate_from')
3030
kwargs['uniqueness'] = kwargs.pop('uniqueness', get_language_codes())
3131

32-
super(LocalizedAutoSlugField, self).__init__(
32+
super(LocalizedUniqueSlugField, self).__init__(
3333
*args,
3434
**kwargs
3535
)
3636

37-
def pre_save(self, instance, add: bool):
37+
def pre_save(self, instance, _add: bool):
3838
"""Ran just before the model is saved, allows us to built
3939
the slug.
4040

0 commit comments

Comments
 (0)