From a5391db76a20c8bb35a7bc0192870fddf747c54c Mon Sep 17 00:00:00 2001 From: Baptiste Mispelon Date: Sun, 9 Feb 2014 10:50:09 +0000 Subject: [PATCH] Fixed inaccuracies in generic mixins documentation. --- docs/ref/class-based-views/generic-editing.txt | 11 +++++++++++ docs/ref/class-based-views/mixins-editing.txt | 10 ++++++---- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/ref/class-based-views/generic-editing.txt b/docs/ref/class-based-views/generic-editing.txt index 51dfe7c71b..bb83fa597e 100644 --- a/docs/ref/class-based-views/generic-editing.txt +++ b/docs/ref/class-based-views/generic-editing.txt @@ -111,6 +111,12 @@ CreateView creating objects for the example ``Author`` model would cause the default ``template_name`` to be ``'myapp/author_create_form.html'``. + .. attribute:: object + + When using ``CreateView`` you have access to ``self.object``, which is + the object being created. If the object hasn't been created yet, the + value will be ``None``. + **Example myapp/views.py**:: from django.views.generic.edit import CreateView @@ -162,6 +168,11 @@ UpdateView updating objects for the example ``Author`` model would cause the default ``template_name`` to be ``'myapp/author_update_form.html'``. + .. attribute:: object + + When using ``UpdateView`` you have access to ``self.object``, which is + the object being updated. + **Example myapp/views.py**:: from django.views.generic.edit import UpdateView diff --git a/docs/ref/class-based-views/mixins-editing.txt b/docs/ref/class-based-views/mixins-editing.txt index bf1c10df13..dbe1c91547 100644 --- a/docs/ref/class-based-views/mixins-editing.txt +++ b/docs/ref/class-based-views/mixins-editing.txt @@ -12,7 +12,7 @@ The following mixins are used to construct Django's editing views: .. note:: Examples of how these are combined into editing views can be found at - the documentation on ``Generic editing views``. + the documentation on :doc:`/ref/class-based-views/generic-editing`. FormMixin --------- @@ -112,9 +112,7 @@ ModelFormMixin mixin have access to the :attr:`~django.views.generic.detail.SingleObjectMixin.model` and :attr:`~django.views.generic.detail.SingleObjectMixin.queryset` attributes, - describing the type of object that the ``ModelForm`` is manipulating. The - view also provides ``self.object``, the instance being manipulated. If the - instance is being created, ``self.object`` will be ``None``. + describing the type of object that the ``ModelForm`` is manipulating. **Mixins** @@ -218,6 +216,10 @@ ProcessFormView The ``PUT`` action is also handled and just passes all parameters through to :meth:`post`. + +DeletionMixin +------------- + .. class:: django.views.generic.edit.DeletionMixin Enables handling of the ``DELETE`` http action.