Skip to content

Commit

Permalink
Update docs about original field value status.
Browse files Browse the repository at this point in the history
  • Loading branch information
zlorf committed Sep 20, 2016
1 parent b6cc688 commit fd3a674
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
v0.12
=====
Date: ???

ADDED: Support for Django 1.10
CHANGED: Original field value became more unreliable and undetermined;
please make sure you're not using it anywhere. See
http://django-modeltranslation.readthedocs.io/en/latest/usage.html#the-state-of-the-original-field

v0.11
=====
Date: 2016-01-31
Expand Down
4 changes: 4 additions & 0 deletions docs/modeltranslation/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,7 @@ The State of the Original Field
-------------------------------

.. versionchanged:: 0.5
.. versionchanged:: 0.12

As defined by the :ref:`rules`, accessing the original field is guaranteed to
work on the associated translation field of the current language. This applies
Expand All @@ -359,6 +360,9 @@ Attempts to keep the value in sync with either the default or current
language's field value has raised a boatload of unpredictable side effects in
older versions of modeltranslation.

Since version 0.12 the original field is expected to have even more undetermined value.
It's because Django 1.10 changed the way deferred fields work.

.. warning::
Do not rely on the underlying value of the *original field* in any way!

Expand Down

0 comments on commit fd3a674

Please sign in to comment.