Skip to content

Commit e4feeba

Browse files
committed
Turn on dangling-reference warning in sphinx for local builds.
Reformat the HTTPFile docs where were causing odd reference errors.
1 parent ae61c71 commit e4feeba

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
SPHINXOPTS=-W -d build/doctrees .
1+
SPHINXOPTS=-n -W -d build/doctrees .
22

33
.PHONY: sphinx
44
sphinx:

tornado/httputil.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -216,10 +216,9 @@ class HTTPFile(ObjectDict):
216216
"""Represents an HTTP file. For backwards compatibility, its instance
217217
attributes are also accessible as dictionary keys.
218218
219-
:ivar filename:
220-
:ivar body:
221-
:ivar content_type: The content_type comes from the provided HTTP header
222-
and should not be trusted outright given that it can be easily forged.
219+
* ``filename``
220+
* ``body``
221+
* ``content_type``
223222
"""
224223
pass
225224

0 commit comments

Comments
 (0)