Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Doc cleanups.

* Fix doc generation for httpclient.py (unescaped \r\n)
* Manually specify signature of Template constructor
* Include IOLoop.time

Closes #644.
  • Loading branch information...
commit 8c5ad60da3909b13b6d3f8e52657c1ff5fa61534 1 parent 12c4e9f
@bdarnell bdarnell authored
View
2  tornado/httpclient.py
@@ -221,7 +221,7 @@ def __init__(self, url, method="GET", headers=None, body=None,
validate_cert=None, ca_certs=None,
allow_ipv6=None,
client_key=None, client_cert=None):
- """Creates an `HTTPRequest`.
+ r"""Creates an `HTTPRequest`.
All parameters except `url` are optional.
View
3  tornado/template.py
@@ -203,6 +203,9 @@ class Template(object):
We compile into Python from the given template_string. You can generate
the template from variables with generate().
"""
+ # note that the constructor's signature is not extracted with
+ # autodoc because _UNSET looks like garbage. When changing
+ # this signature update website/sphinx/template.rst too.
def __init__(self, template_string, name="<string>", loader=None,
compress_whitespace=None, autoescape=_UNSET):
self.name = name
View
3  website/sphinx/conf.py
@@ -30,6 +30,9 @@
"Runner",
"YieldPoint",
+ # tornado.ioloop
+ "PollIOLoop",
+
# tornado.web
"ChunkedTransferEncoding",
"GZipContentEncoding",
View
5 website/sphinx/ioloop.rst
@@ -25,14 +25,15 @@
.. automethod:: IOLoop.update_handler
.. automethod:: IOLoop.remove_handler
- Timeouts
- ^^^^^^^^
+ Callbacks and timeouts
+ ^^^^^^^^^^^^^^^^^^^^^^
.. automethod:: IOLoop.add_callback
.. automethod:: IOLoop.add_callback_from_signal
.. automethod:: IOLoop.add_future
.. automethod:: IOLoop.add_timeout
.. automethod:: IOLoop.remove_timeout
+ .. automethod:: IOLoop.time
.. autoclass:: PeriodicCallback
:members:
View
2  website/sphinx/template.rst
@@ -6,7 +6,7 @@
Class reference
---------------
- .. autoclass:: Template
+ .. autoclass:: Template(template_string, name="<string>", loader=None, compress_whitespace=None, autoescape="xhtml_escape")
:members:
.. autoclass:: BaseLoader
Please sign in to comment.
Something went wrong with that request. Please try again.