From 84c267330fb7b84a7c9f688fe8c5885f52b83589 Mon Sep 17 00:00:00 2001 From: Swen Kooij Date: Thu, 25 May 2017 19:11:39 +0300 Subject: [PATCH] Update docs on new import style --- README.rst | 16 ++++++---------- localized_fields/admin.py | 5 +++++ 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 4c8e6bd..dc722ec 100644 --- a/README.rst +++ b/README.rst @@ -160,7 +160,7 @@ By default the values stored in a ``LocalizedField`` are *not unique*. You can e .. code-block:: python - from localized_fields import get_language_codes + from localized_fields.util import get_language_codes class MyModel(models.Model): title = LocalizedField(uniqueness=get_language_codes()) @@ -176,7 +176,7 @@ By default the values stored in a ``LocalizedField`` are *not unique*. You can e .. code-block:: python - from localized_fields import get_language_codes + from localized_fields.util import get_language_codes class MyModel(models.Model): title = LocalizedField(uniqueness=[(*get_language_codes())]) @@ -192,10 +192,8 @@ Besides ``LocalizedField``, there's also: .. code-block:: python - from localized_fields import (LocalizedModel, - AtomicSlugRetryMixin, - LocalizedField, - LocalizedUniqueSlugField) + from localized_fields.models import LocalizedModel + from localized_fields.fields import LocalizedField, LocalizedUniqueSlugField class MyModel(AtomicSlugRetryMixin, LocalizedModel): title = LocalizedField() @@ -217,8 +215,7 @@ Besides ``LocalizedField``, there's also: .. code-block:: python - from localized_fields import (LocalizedField, - LocalizedUniqueSlugField) + from localized_fields.fields import LocalizedField, LocalizedAutoSlugField class MyModel(models.Model): title = LocalizedField() @@ -235,8 +232,7 @@ Besides ``LocalizedField``, there's also: .. code-block:: python - from localized_fields import (LocalizedField, - LocalizedBleachField) + from localized_fields.fields import LocalizedField, LocalizedBleachField class MyModel(models.Model): title = LocalizedField() diff --git a/localized_fields/admin.py b/localized_fields/admin.py index 5677de6..4c54303 100644 --- a/localized_fields/admin.py +++ b/localized_fields/admin.py @@ -10,17 +10,22 @@ FORMFIELD_FOR_LOCALIZED_FIELDS_DEFAULTS = { class LocalizedFieldsAdminMixin(ModelAdmin): + """Mixin for making the fancy widgets work in Django Admin.""" + class Media: css = { 'all': ( 'localized_fields/localized-fields-admin.css', ) } + js = ( 'localized_fields/localized-fields-admin.js', ) def __init__(self, *args, **kwargs): + """Initializes a new instance of :see:LocalizedFieldsAdminMixin.""" + super(LocalizedFieldsAdminMixin, self).__init__(*args, **kwargs) overrides = FORMFIELD_FOR_LOCALIZED_FIELDS_DEFAULTS.copy() overrides.update(self.formfield_overrides)