Commits

Mark Lavin  committed 795843a

Add docs/release notes. Fixes #40.

  • Participants
  • Parent commits 4b3a1f6

Comments (0)

Files changed (2)

File docs/releases.rst

 Release Notes
 ==================
 
-v0.3.0 (Released Released 2012-02-15)
+v0.4.0 (Released TBD)
+--------------------------------------
+
+Features
+_________________
+
+- Better compatibility with :ref:`AutoCompleteSelectWidget`/:ref:`AutoComboboxSelectWidget` and Django's ModelChoiceField
+
+
+v0.3.0 (Released 2012-02-15)
 --------------------------------------
 
 Features

File docs/widgets.rst

 This widget should be used in conjunction with the :ref:`AutoCompleteSelectField` as it will
 return both the text entered by the user and the id (if an item was selected/matched).
 
+.. versionadded:: 0.4
+
+Prior to 0.4 :ref:`AutoCompleteSelectWidget` could not work directly with Django's
+`ModelChoiceField <https://docs.djangoproject.com/en/1.3/ref/forms/fields/#modelchoicefield>`_.
+Starting with 0.4 you can simply replace the widget without replacing the entire field.
+
+    .. code-block:: python
+
+        class FarmAdminForm(forms.ModelForm):
+
+            class Meta(object):
+                model = Farm
+                widgets = {
+                    'owner': selectable.AutoCompleteSelectWidget(lookup_class=FruitLookup),
+                }
+
+The one catch is that you must use ``allow_new=False`` which is the default.
+
 
 .. _AutoComboboxSelectWidget:
 
 
 Similar to :ref:`AutoCompleteSelectWidget` but has a button to reveal all options.
 
+.. versionadded:: 0.4
+
+Prior to 0.4 :ref:`AutoComboboxSelectWidget` could not work directly with Django's
+`ModelChoiceField <https://docs.djangoproject.com/en/1.3/ref/forms/fields/#modelchoicefield>`_.
+Starting with 0.4 you can simply replace the widget without replacing the entire field.
+
+    .. code-block:: python
+
+        class FarmAdminForm(forms.ModelForm):
+
+            class Meta(object):
+                model = Farm
+                widgets = {
+                    'owner': selectable.AutoComboboxSelectWidget(lookup_class=FruitLookup),
+                }
+
+The one catch is that you must use ``allow_new=False`` which is the default.
+
 
 .. _AutoCompleteSelectMultipleWidget: