Fixed some Sphinx markup in signals docs. (c5cc26ff) · Commits · Dom Sekotill / django

docs/ref/contrib/comments/signals.txt

+6 −1

Original line number	Diff line number	Diff line
		@@ -16,6 +16,7 @@ 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
		submitted. This can be used to modify the comment (in place) with posting
		@@ -44,6 +45,7 @@ comment_was_posted
		==================

		.. data:: django.contrib.comments.signals.comment_was_posted
		:module:

		Sent just after the comment is saved.

		@@ -63,6 +65,9 @@ Arguments sent with this signal:
		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
		was a user requesting removal of a comment, a moderator approving/removing a
		comment, or some other custom user flag.

docs/ref/signals.txt

+24 −10

Original line number	Diff line number	Diff line
		@@ -33,7 +33,10 @@ module system.
		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
		of the model's :meth:`~django.db.models.Model.__init__` method.
		@@ -74,6 +77,7 @@ 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.

		@@ -89,6 +93,7 @@ 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`
		method.
		@@ -105,6 +110,7 @@ post_save
		---------

		.. data:: django.db.models.signals.post_save
		:module:

		Like :data:`pre_save`, but sent at the end of the
		:meth:`~django.db.models.Model.save` method.
		@@ -124,6 +130,7 @@ pre_delete
		----------

		.. data:: django.db.models.signals.pre_delete
		:module:

		Sent at the beginning of a model's :meth:`~django.db.models.Model.delete`
		method.
		@@ -140,6 +147,7 @@ post_delete
		-----------

		.. data:: django.db.models.signals.post_delete
		:module:

		Like :data:`pre_delete`, but sent at the end of the
		:meth:`~django.db.models.Model.delete` method.
		@@ -159,6 +167,7 @@ class_prepared
		--------------

		.. data:: django.db.models.signals.class_prepared
		:module:

		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
		@@ -178,6 +187,7 @@ post_syncdb
		-----------

		.. data:: django.db.models.signals.post_syncdb
		:module:

		Sent by :djadmin:`syncdb` after it installs an application.

		@@ -227,6 +237,7 @@ request_started
		---------------

		.. data:: django.core.signals.request_started
		:module:

		Sent when Django begins processing an HTTP request.

		@@ -242,6 +253,7 @@ request_finished
		----------------

		.. data:: django.core.signals.request_finished
		:module:

		Sent when Django finishes processing an HTTP request.

		@@ -254,6 +266,7 @@ 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.

		@@ -277,6 +290,7 @@ template_rendered
		-----------------

		.. data:: django.test.signals.template_rendered
		:module:

		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.