Fixed some Sphinx markup in signals docs.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8591 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
parent
6f29ad31b5
commit
c5cc26ff99
|
@ -16,6 +16,7 @@ comment_will_be_posted
|
||||||
======================
|
======================
|
||||||
|
|
||||||
.. data:: django.contrib.comments.signals.comment_will_be_posted
|
.. data:: django.contrib.comments.signals.comment_will_be_posted
|
||||||
|
:module:
|
||||||
|
|
||||||
Sent just before a comment will be saved, after it's been sanity checked and
|
Sent just before a comment will be saved, after it's been sanity checked and
|
||||||
submitted. This can be used to modify the comment (in place) with posting
|
submitted. This can be used to modify the comment (in place) with posting
|
||||||
|
@ -44,7 +45,8 @@ comment_was_posted
|
||||||
==================
|
==================
|
||||||
|
|
||||||
.. data:: django.contrib.comments.signals.comment_was_posted
|
.. data:: django.contrib.comments.signals.comment_was_posted
|
||||||
|
:module:
|
||||||
|
|
||||||
Sent just after the comment is saved.
|
Sent just after the comment is saved.
|
||||||
|
|
||||||
Arguments sent with this signal:
|
Arguments sent with this signal:
|
||||||
|
@ -63,6 +65,9 @@ Arguments sent with this signal:
|
||||||
comment_was_flagged
|
comment_was_flagged
|
||||||
===================
|
===================
|
||||||
|
|
||||||
|
.. data:: django.contrib.comments.signals.comment_was_flagged
|
||||||
|
:module:
|
||||||
|
|
||||||
Sent after a comment was "flagged" in some way. Check the flag to see if this
|
Sent after a comment was "flagged" in some way. Check the flag to see if this
|
||||||
was a user requesting removal of a comment, a moderator approving/removing a
|
was a user requesting removal of a comment, a moderator approving/removing a
|
||||||
comment, or some other custom user flag.
|
comment, or some other custom user flag.
|
||||||
|
|
|
@ -33,7 +33,10 @@ module system.
|
||||||
pre_init
|
pre_init
|
||||||
--------
|
--------
|
||||||
|
|
||||||
.. data:: django.db.models.signals.pre_init
|
.. attribute:: django.db.models.signals.pre_init
|
||||||
|
:module:
|
||||||
|
|
||||||
|
.. ^^^^^^^ this :module: hack keeps Sphinx from prepending the module.
|
||||||
|
|
||||||
Whenever you instantiate a Django model,, this signal is sent at the beginning
|
Whenever you instantiate a Django model,, this signal is sent at the beginning
|
||||||
of the model's :meth:`~django.db.models.Model.__init__` method.
|
of the model's :meth:`~django.db.models.Model.__init__` method.
|
||||||
|
@ -74,6 +77,7 @@ post_init
|
||||||
---------
|
---------
|
||||||
|
|
||||||
.. data:: django.db.models.signals.post_init
|
.. data:: django.db.models.signals.post_init
|
||||||
|
:module:
|
||||||
|
|
||||||
Like pre_init, but this one is sent when the :meth:`~django.db.models.Model.__init__`: method finishes.
|
Like pre_init, but this one is sent when the :meth:`~django.db.models.Model.__init__`: method finishes.
|
||||||
|
|
||||||
|
@ -89,7 +93,8 @@ pre_save
|
||||||
--------
|
--------
|
||||||
|
|
||||||
.. data:: django.db.models.signals.pre_save
|
.. data:: django.db.models.signals.pre_save
|
||||||
|
:module:
|
||||||
|
|
||||||
This is sent at the beginning of a model's :meth:`~django.db.models.Model.save`
|
This is sent at the beginning of a model's :meth:`~django.db.models.Model.save`
|
||||||
method.
|
method.
|
||||||
|
|
||||||
|
@ -105,7 +110,8 @@ post_save
|
||||||
---------
|
---------
|
||||||
|
|
||||||
.. data:: django.db.models.signals.post_save
|
.. data:: django.db.models.signals.post_save
|
||||||
|
:module:
|
||||||
|
|
||||||
Like :data:`pre_save`, but sent at the end of the
|
Like :data:`pre_save`, but sent at the end of the
|
||||||
:meth:`~django.db.models.Model.save` method.
|
:meth:`~django.db.models.Model.save` method.
|
||||||
|
|
||||||
|
@ -124,7 +130,8 @@ pre_delete
|
||||||
----------
|
----------
|
||||||
|
|
||||||
.. data:: django.db.models.signals.pre_delete
|
.. data:: django.db.models.signals.pre_delete
|
||||||
|
:module:
|
||||||
|
|
||||||
Sent at the beginning of a model's :meth:`~django.db.models.Model.delete`
|
Sent at the beginning of a model's :meth:`~django.db.models.Model.delete`
|
||||||
method.
|
method.
|
||||||
|
|
||||||
|
@ -140,7 +147,8 @@ post_delete
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
.. data:: django.db.models.signals.post_delete
|
.. data:: django.db.models.signals.post_delete
|
||||||
|
:module:
|
||||||
|
|
||||||
Like :data:`pre_delete`, but sent at the end of the
|
Like :data:`pre_delete`, but sent at the end of the
|
||||||
:meth:`~django.db.models.Model.delete` method.
|
:meth:`~django.db.models.Model.delete` method.
|
||||||
|
|
||||||
|
@ -159,7 +167,8 @@ class_prepared
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
.. data:: django.db.models.signals.class_prepared
|
.. data:: django.db.models.signals.class_prepared
|
||||||
|
:module:
|
||||||
|
|
||||||
Sent whenever a model class has been "prepared" -- that is, once model has
|
Sent whenever a model class has been "prepared" -- that is, once model has
|
||||||
been defined and registered with Django's model system. Django uses this
|
been defined and registered with Django's model system. Django uses this
|
||||||
signal internally; it's not generally used in third-party applications.
|
signal internally; it's not generally used in third-party applications.
|
||||||
|
@ -178,6 +187,7 @@ post_syncdb
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
.. data:: django.db.models.signals.post_syncdb
|
.. data:: django.db.models.signals.post_syncdb
|
||||||
|
:module:
|
||||||
|
|
||||||
Sent by :djadmin:`syncdb` after it installs an application.
|
Sent by :djadmin:`syncdb` after it installs an application.
|
||||||
|
|
||||||
|
@ -227,7 +237,8 @@ request_started
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
.. data:: django.core.signals.request_started
|
.. data:: django.core.signals.request_started
|
||||||
|
:module:
|
||||||
|
|
||||||
Sent when Django begins processing an HTTP request.
|
Sent when Django begins processing an HTTP request.
|
||||||
|
|
||||||
Arguments sent with this signal:
|
Arguments sent with this signal:
|
||||||
|
@ -242,7 +253,8 @@ request_finished
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
.. data:: django.core.signals.request_finished
|
.. data:: django.core.signals.request_finished
|
||||||
|
:module:
|
||||||
|
|
||||||
Sent when Django finishes processing an HTTP request.
|
Sent when Django finishes processing an HTTP request.
|
||||||
|
|
||||||
Arguments sent with this signal:
|
Arguments sent with this signal:
|
||||||
|
@ -254,7 +266,8 @@ got_request_exception
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
.. data:: django.core.signals.got_request_exception
|
.. data:: django.core.signals.got_request_exception
|
||||||
|
:module:
|
||||||
|
|
||||||
This signal is sent whenever Django encounters an exception while processing an incoming HTTP request.
|
This signal is sent whenever Django encounters an exception while processing an incoming HTTP request.
|
||||||
|
|
||||||
Arguments sent with this signal:
|
Arguments sent with this signal:
|
||||||
|
@ -277,7 +290,8 @@ template_rendered
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
.. data:: django.test.signals.template_rendered
|
.. data:: django.test.signals.template_rendered
|
||||||
|
:module:
|
||||||
|
|
||||||
Sent when the test system renders a template. This signal is not emitted during
|
Sent when the test system renders a template. This signal is not emitted during
|
||||||
normal operation of a Django server -- it is only available during testing.
|
normal operation of a Django server -- it is only available during testing.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue