]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
Turn on dangling-reference warning in sphinx for local builds.
authorBen Darnell <ben@bendarnell.com>
Sat, 16 Mar 2013 14:34:00 +0000 (10:34 -0400)
committerBen Darnell <ben@bendarnell.com>
Sat, 16 Mar 2013 14:34:34 +0000 (10:34 -0400)
Reformat the HTTPFile docs where were causing odd reference errors.

docs/Makefile
tornado/httputil.py

index 1b8b30debb1b18f5cebc773732f1922ca43301ba..97b258758dd9875f0186631ad115ddfd07302983 100644 (file)
@@ -1,4 +1,4 @@
-SPHINXOPTS=-W -d build/doctrees .
+SPHINXOPTS=-n -W -d build/doctrees .
 
 .PHONY: sphinx
 sphinx:
index 3fd709b81ddab55a3f7bd14205ecbc18a9b43fe9..8a7c2139762a7571f2179e7f3007ee343455b2a5 100644 (file)
@@ -216,10 +216,9 @@ class HTTPFile(ObjectDict):
     """Represents an HTTP file. For backwards compatibility, its instance
     attributes are also accessible as dictionary keys.
 
-    :ivar filename:
-    :ivar body:
-    :ivar content_type: The content_type comes from the provided HTTP header
-        and should not be trusted outright given that it can be easily forged.
+    * ``filename``
+    * ``body``
+    * ``content_type``
     """
     pass