From 90b64db39c4fd1243182068c3a54c3e08cd0f4b9 Mon Sep 17 00:00:00 2001 From: areski Date: Fri, 15 Aug 2014 19:58:50 +0200 Subject: [PATCH] Fixed syntax highlighting and indentation in docs/topics/logging.txt. --- docs/topics/logging.txt | 71 ++++++++++++++++++++++++----------------- 1 file changed, 41 insertions(+), 30 deletions(-) diff --git a/docs/topics/logging.txt b/docs/topics/logging.txt index 5a7d136859..b515544ebd 100644 --- a/docs/topics/logging.txt +++ b/docs/topics/logging.txt @@ -481,13 +481,16 @@ a ``SuspiciousOperation`` will not be logged to the ``django.request`` logger, but only to the ``django.security`` logger. To silence a particular type of SuspiciousOperation, you can override that -specific logger following this example:: +specific logger following this example: - 'loggers': { - 'django.security.DisallowedHost': { - 'handlers': ['null'], - 'propagate': False, - }, +.. code-block:: python + + 'loggers': { + 'django.security.DisallowedHost': { + 'handlers': ['null'], + 'propagate': False, + }, + }, ``django.db.backends.schema`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -520,7 +523,9 @@ Python logging module. containing the full content of the debug Web page that would have been produced if :setting:`DEBUG` were ``True``. To set this value in your configuration, include it in the handler definition for - ``django.utils.log.AdminEmailHandler``, like this:: + ``django.utils.log.AdminEmailHandler``, like this: + + .. code-block:: python 'handlers': { 'mail_admins': { @@ -542,7 +547,9 @@ Python logging module. By setting the ``email_backend`` argument of ``AdminEmailHandler``, the :ref:`email backend ` that is being used by the - handler can be overridden, like this:: + handler can be overridden, like this: + + .. code-block:: python 'handlers': { 'mail_admins': { @@ -566,25 +573,27 @@ logging module. .. class:: CallbackFilter(callback) - This filter accepts a callback function (which should accept a single - argument, the record to be logged), and calls it for each record that passes - through the filter. Handling of that record will not proceed if the callback - returns False. + This filter accepts a callback function (which should accept a single + argument, the record to be logged), and calls it for each record that + passes through the filter. Handling of that record will not proceed if the + callback returns False. - For instance, to filter out :exc:`~django.http.UnreadablePostError` - (raised when a user cancels an upload) from the admin emails, you would - create a filter function:: + For instance, to filter out :exc:`~django.http.UnreadablePostError` + (raised when a user cancels an upload) from the admin emails, you would + create a filter function:: - from django.http import UnreadablePostError + from django.http import UnreadablePostError - def skip_unreadable_post(record): - if record.exc_info: - exc_type, exc_value = record.exc_info[:2] - if isinstance(exc_value, UnreadablePostError): - return False - return True + def skip_unreadable_post(record): + if record.exc_info: + exc_type, exc_value = record.exc_info[:2] + if isinstance(exc_value, UnreadablePostError): + return False + return True - and then add it to your logging config:: + and then add it to your logging config: + + .. code-block:: python 'filters': { 'skip_unreadable_posts': { @@ -602,13 +611,15 @@ logging module. .. class:: RequireDebugFalse() - This filter will only pass on records when settings.DEBUG is False. + This filter will only pass on records when settings.DEBUG is False. - This filter is used as follows in the default :setting:`LOGGING` - configuration to ensure that the :class:`AdminEmailHandler` only sends error - emails to admins when :setting:`DEBUG` is ``False``:: + This filter is used as follows in the default :setting:`LOGGING` + configuration to ensure that the :class:`AdminEmailHandler` only sends + error emails to admins when :setting:`DEBUG` is ``False``: - 'filters': { + .. code-block:: python + + 'filters': { 'require_debug_false': { '()': 'django.utils.log.RequireDebugFalse', } @@ -623,8 +634,8 @@ logging module. .. class:: RequireDebugTrue() - This filter is similar to :class:`RequireDebugFalse`, except that records are - passed only when :setting:`DEBUG` is ``True``. + This filter is similar to :class:`RequireDebugFalse`, except that records are + passed only when :setting:`DEBUG` is ``True``. .. _default-logging-configuration: