Commit b855dbf6 authored by Gabriel Hurley's avatar Gabriel Hurley
Browse files

[1.2.X] Fixed #14477 -- Corrects several instances of "add" and "remove"... 

[1.2.X] Fixed #14477 -- Corrects several instances of "add" and "remove" m2m_changed signal actions not having been updated to "pre_add", "post_add", etc. Thanks to slink and andrews for reporting several instances of it, and andrews for the draft patch.

Backport of [14304] from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@14305 bcc190cf-cafb-0310-a4f2-bffc1f526a37
parent 1160d81e

docs/ref/signals.txt

+8 −7
Original line number Diff line number Diff line
@@ -221,10 +221,11 @@ Arguments sent with this signal: 
        from the relation.



    ``pk_set``

        With the ``"add"`` and ``"remove"`` action, this is a list of

        primary key values that have been added to or removed from the relation.

        For the ``pre_add``, ``post_add``, ``pre_remove`` and ``post_remove``

        actions, this is a list of primary key values that have been added to

        or removed from the relation.



        For the ``"clear"`` action, this is ``None``.

        For the ``pre_clear`` and ``post_clear`` actions, this is ``None``.



For example, if a ``Pizza`` can have multiple ``Topping`` objects, modeled

like this:
@@ -255,7 +256,7 @@ the arguments sent to a :data:`m2m_changed` handler would be: 


    ``instance``    ``p`` (the ``Pizza`` instance being modified)



    ``action``      ``"add"``

    ``action``      ``"pre_add"`` (followed by a separate signal with ``"post_add"``)



    ``reverse``     ``False`` (``Pizza`` contains the :class:`ManyToManyField`,

                    so this call modifies the forward relation)
@@ -281,7 +282,7 @@ the arguments sent to a :data:`m2m_changed` handler would be: 


    ``instance``    ``t`` (the ``Topping`` instance being modified)



    ``action``      ``"remove"``

    ``action``      ``"pre_remove"`` (followed by a separate signal with ``"post_remove"``)



    ``reverse``     ``True`` (``Pizza`` contains the :class:`ManyToManyField`,

                    so this call modifies the reverse relation)