Missing clean_password in custom user documentation

[DavidW]

​https://docs.djangoproject.com/en/dev/topics/auth/#auth-custom-user

class UserChangeForm(forms.ModelForm):
    """A form for updateing users. Includes all the fields on
    the user, but replaces the password field with admin's
    pasword hash display field.
    """
    password = ReadOnlyPasswordHashField()

    class Meta:
        model = MyUser

Needs the following added:

    def clean_password(self):
        # Regardless of what the user provides, return the initial value.
        # This is done here, rather than on the field, because the
        # field does not have access to the initial value
        return self.initial["password"]

Or you get a not-null constraint violation on form submit.

[Aymeric Augustin]

Fixed formatting (please use preview).

[Russell Keith-Magee]

Actually, this should be a release blocker, since it's a fundamentally misleading piece of documentation in a new feature.

[Tim Graham]

Fixed in e8f696097b19abbd3a98990ea4ca5f58d0444826