From: Ben Darnell <ben@bendarnell.com>
Date: Sun, 20 May 2012 23:57:36 +0000 (-0700)
Subject: Fix docstring formatting
X-Git-Tag: v2.3.0~22
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4c6f1137f1ce8ebb07ef6c3a9be340ed993132ad;p=thirdparty%2Ftornado.git

Fix docstring formatting
---

diff --git a/tornado/escape.py b/tornado/escape.py
index 71083e775..ed07c53d1 100644
--- a/tornado/escape.py
+++ b/tornado/escape.py
@@ -248,13 +248,15 @@ def linkify(text, shorten=False, extra_params="",
 
     extra_params: Extra text to include in the link tag, or a callable
         taking the link as an argument and returning the extra text
-        e.g. linkify(text, extra_params='rel="nofollow" class="external"')
-          or def extra_params_cb(url):
-                 if url.startswith("http://example.com"):
-                     return 'class="internal"'
-                 else:
-                     return 'class="external" rel="nofollow"'
-             linkify(text, extra_params=extra_params_cb)
+        e.g. ``linkify(text, extra_params='rel="nofollow" class="external"')``,
+        or::
+
+            def extra_params_cb(url):
+                if url.startswith("http://example.com"):
+                    return 'class="internal"'
+                else:
+                    return 'class="external" rel="nofollow"'
+            linkify(text, extra_params=extra_params_cb)
 
     require_protocol: Only linkify urls which include a protocol. If this is
         False, urls such as www.facebook.com will also be linkified.