From: Ben Darnell <ben@bendarnell.com>
Date: Sun, 1 Dec 2013 20:04:02 +0000 (-0500)
Subject: Document the attributes required by @run_on_executor.
X-Git-Tag: v3.2.0b1~33
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cb653c5ef9e865b312da78a0c8d666ec7dd6043e;p=thirdparty%2Ftornado.git

Document the attributes required by @run_on_executor.

Closes #933.
---

diff --git a/tornado/concurrent.py b/tornado/concurrent.py
index 9a10905e9..a9002b16a 100644
--- a/tornado/concurrent.py
+++ b/tornado/concurrent.py
@@ -151,6 +151,9 @@ def run_on_executor(fn):
 
     The decorated method may be called with a ``callback`` keyword
     argument and returns a future.
+
+    This decorator should be used only on methods of objects with attributes
+    ``executor`` and ``io_loop``.
     """
     @functools.wraps(fn)
     def wrapper(self, *args, **kwargs):