diff --git a/eav/__init__.py b/eav/__init__.py index 709ff58..706372d 100644 --- a/eav/__init__.py +++ b/eav/__init__.py @@ -1,6 +1,5 @@ __version__ = '0.9.2' - def register(model_cls, config_cls=None): from .registry import Registry Registry.register(model_cls, config_cls) diff --git a/eav/admin.py b/eav/admin.py index 5545d02..120fad3 100644 --- a/eav/admin.py +++ b/eav/admin.py @@ -1,3 +1,5 @@ +'''Admin. This module contains classes used for admin integration.''' + from django.contrib import admin from django.contrib.admin.options import (InlineModelAdmin, ModelAdmin, StackedInline) diff --git a/eav/decorators.py b/eav/decorators.py index e4fd772..0dfb355 100644 --- a/eav/decorators.py +++ b/eav/decorators.py @@ -1,5 +1,5 @@ ''' -Decorators module. +Decorators. This module contains pure wrapper functions used as decorators. Functions in this module should be simple and not involve complex logic. diff --git a/eav/fields.py b/eav/fields.py index 7e93ce4..de40f24 100644 --- a/eav/fields.py +++ b/eav/fields.py @@ -1,15 +1,9 @@ ''' -****** -fields -****** +Fields. Contains two custom fields: - -* :class:`EavSlugField` -* :class:`EavDatatypeField` - -Classes -------- + * :class:`EavSlugField` + * :class:`EavDatatypeField` ''' import re diff --git a/eav/forms.py b/eav/forms.py index 7d3f2e7..dc1a622 100644 --- a/eav/forms.py +++ b/eav/forms.py @@ -1,13 +1,5 @@ -''' -##### -forms -##### +'''Forms. This module contains forms used for admin integration.''' -The forms used for admin integration - -Classes -------- -''' from copy import deepcopy from django.contrib.admin.widgets import AdminSplitDateTime diff --git a/eav/managers.py b/eav/managers.py index 65dab0e..2531ce9 100644 --- a/eav/managers.py +++ b/eav/managers.py @@ -1,12 +1,9 @@ ''' -******** -managers -******** -Contains the custom manager used by entities registered with eav. +Managers. -Functions and Classes ---------------------- +This module contains the custom manager used by entities registered with eav. ''' + from django.db import models from .queryset import EavQuerySet @@ -14,7 +11,7 @@ from .queryset import EavQuerySet class EntityManager(models.Manager): ''' - Our custom manager, overriding ``models.Manager`` + Our custom manager, overrides ``models.Manager``. ''' _queryset_class = EavQuerySet diff --git a/eav/models.py b/eav/models.py index 4cbf395..30982f5 100644 --- a/eav/models.py +++ b/eav/models.py @@ -1,21 +1,15 @@ ''' -****** -models -****** -This module defines the four concrete, non-abstract models: +Models. -* :class:`Value` -* :class:`Attribute` -* :class:`EnumValue` -* :class:`EnumGroup` +This module defines the four concrete, non-abstract models: + * :class:`Value` + * :class:`Attribute` + * :class:`EnumValue` + * :class:`EnumGroup` Along with the :class:`Entity` helper class. - -Classes -------- ''' - from django.conf import settings from django.contrib.contenttypes import fields as generic from django.contrib.contenttypes.models import ContentType diff --git a/eav/queryset.py b/eav/queryset.py index 4ac3cac..9f75e5f 100644 --- a/eav/queryset.py +++ b/eav/queryset.py @@ -1,5 +1,5 @@ ''' -Queryset module. +Queryset. This module contains custom EavQuerySet class used for overriding relational operators and pure functions for rewriting Q-expressions. diff --git a/eav/registry.py b/eav/registry.py index 7471090..b4b0896 100644 --- a/eav/registry.py +++ b/eav/registry.py @@ -1,13 +1,4 @@ -''' -######## -registry -######## - -This contains the registry classes - -Classes -------- -''' +'''Registry. This modules contains the registry classes.''' from django.contrib.contenttypes import fields as generic from django.db.models.signals import post_init, post_save, pre_init, pre_save diff --git a/eav/utils.py b/eav/utils.py index 508d2ee..ea6ab27 100644 --- a/eav/utils.py +++ b/eav/utils.py @@ -1,3 +1,5 @@ +'''Utilities. This module contains non-essential helper methods.''' + import sys from django.db.models import Q diff --git a/eav/validators.py b/eav/validators.py index a9617be..8998425 100644 --- a/eav/validators.py +++ b/eav/validators.py @@ -1,7 +1,6 @@ ''' -********** -validators -********** +Validtors. + This module contains a validator for each Attribute datatype. A validator is a callable that takes a value and raises a ``ValidationError`` @@ -11,9 +10,6 @@ if it doesn’t meet some criteria. (see These validators are called by the :meth:`~eav.models.Attribute.validate_value` method in the :class:`~eav.models.Attribute` model. - -Functions ---------- ''' import datetime