From cedd744e32a8e76681fb33f04d4847b2c81c7253 Mon Sep 17 00:00:00 2001 From: Matthew Tretter Date: Sat, 13 Oct 2012 00:22:30 -0400 Subject: [PATCH] Add description of registry --- imagekit/specs/__init__.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/imagekit/specs/__init__.py b/imagekit/specs/__init__.py index e29cdb6..e3a4407 100644 --- a/imagekit/specs/__init__.py +++ b/imagekit/specs/__init__.py @@ -13,6 +13,16 @@ from ..utils import (open_image, extension_to_format, IKContentFile, class SpecRegistry(object): + """ + An object for registering specs and sources. The two are associated with + eachother via a string id. We do this (as opposed to associating them + directly by, for example, putting a ``sources`` attribute on specs) so that + specs can be overridden without losing the associated sources. That way, + a distributable app can define its own specs without locking the users of + the app into it. + + """ + signals = { source_created: 'source_created', source_changed: 'source_changed',