Skip to content

Commit

Permalink
Minor doc updates, bumping to 1.6 for PyPI release
Browse files Browse the repository at this point in the history
  • Loading branch information
respondcreate committed Jul 29, 2016
1 parent f55a130 commit 440fa58
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@ Table of Contents
Release Notes
=============

1.6
^^^
- Fixed a bug that prevented sized images from deleting properly when the field they were associated with was using a custom ``upload_to`` function. If you are using a custom ``SizedImage`` subclass on your project then be sure to check out :ref:`this section <ensuring-sized-images-deleted>` in the docs.

1.5
^^^
- Fixed a bug that was causing placeholder images to serialize incorrectly with ``VersatileImageFieldSerializer`` (thanks, `@romanosipenko <https://github.com/romanosipenko>`_!).
Expand Down
4 changes: 3 additions & 1 deletion docs/writing_custom_sizers_and_filters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,12 @@ For an example, let's take a look at the ``thumbnail`` Sizer (``versatileimagefi
.. important:: ``process_image`` should *always* return a `StringIO` instance. See :ref:`what-process_image-should-return` for more information.

.. _ensuring-sized-images-deleted:

Ensuring Sized Images Can Be Deleted
------------------------------------

If your ``SizedImage`` subclass uses more than just ``filename key`` to construct filenames than you'll also want to define the ``filename_key_regex`` attribute.
If your ``SizedImage`` subclass uses more than just ``filename_key`` to construct filenames than you'll also want to define the ``filename_key_regex`` attribute.

Confused? Let's take a look at ``CroppedImage`` – which includes individual image PPOI values in the images it creates – as an example:

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
setup(
name='django-versatileimagefield',
packages=find_packages(),
version='1.5',
version='1.6',
author=u'Jonathan Ellenberger',
author_email='jonathan_ellenberger@wgbh.org',
url='http://github.com/respondcreate/django-versatileimagefield/',
Expand Down

0 comments on commit 440fa58

Please sign in to comment.