From ffe0c548919843cd277fd4664ddffa8625821a04 Mon Sep 17 00:00:00 2001 From: Jeff Widman Date: Mon, 9 Feb 2015 01:03:08 -0800 Subject: [PATCH] Grammer and readability fixes --- docs/signals.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/signals.rst b/docs/signals.rst index c83d01c0..ecb49d5f 100644 --- a/docs/signals.rst +++ b/docs/signals.rst @@ -26,7 +26,7 @@ early by returning a response. In contrast all signal handlers are executed in undefined order and do not modify any data. The big advantage of signals over handlers is that you can safely -subscribe to them for the split of a second. These temporary +subscribe to them for just a split second. These temporary subscriptions are helpful for unittesting for example. Say you want to know what templates were rendered as part of a request: signals allow you to do exactly that. @@ -42,11 +42,11 @@ signal, you can use the :meth:`~blinker.base.Signal.disconnect` method. For all core Flask signals, the sender is the application that issued the signal. When you subscribe to a signal, be sure to also provide a sender -unless you really want to listen for signals of all applications. This is +unless you really want to listen for signals from all applications. This is especially true if you are developing an extension. -Here for example a helper context manager that can be used to figure out -in a unittest which templates were rendered and what variables were passed +For example, here is a helper context manager that can be used in a unittest +to determine which templates were rendered and what variables were passed to the template:: from flask import template_rendered @@ -82,10 +82,10 @@ variable. Whenever a template is rendered, the template object as well as context are appended to it. Additionally there is a convenient helper method -(:meth:`~blinker.base.Signal.connected_to`). that allows you to +(:meth:`~blinker.base.Signal.connected_to`) that allows you to temporarily subscribe a function to a signal with a context manager on its own. Because the return value of the context manager cannot be -specified that way one has to pass the list in as argument:: +specified that way, you have to pass the list in as an argument:: from flask import template_rendered @@ -208,8 +208,8 @@ The following signals exist in Flask: .. data:: flask.request_started :noindex: - This signal is sent before any request processing started but when the - request context was set up. Because the request context is already + This signal is sent when the request context is set up, before + any request processing happens. Because the request context is already bound, the subscriber can access the request with the standard global proxies such as :class:`~flask.request`.