Skip to content

Commit ae61c71

Browse files
committed
Fix dangling references in old release notes.
1 parent 1d69855 commit ae61c71

File tree

6 files changed

+86
-87
lines changed

6 files changed

+86
-87
lines changed

docs/releases/v2.1.0.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Backwards-incompatible changes
88
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99

1010
* Support for secure cookies written by pre-1.0 releases of Tornado has
11-
been removed. The `RequestHandler.get_secure_cookie` method no longer
11+
been removed. The `.RequestHandler.get_secure_cookie` method no longer
1212
takes an ``include_name`` parameter.
1313
* The ``debug`` application setting now causes stack traces to be displayed
1414
in the browser on uncaught exceptions. Since this may leak sensitive
@@ -18,7 +18,7 @@ Security fixes
1818
~~~~~~~~~~~~~~
1919

2020
* Diginotar has been removed from the default CA certificates file used
21-
by `SimpleAsyncHTTPClient`.
21+
by ``SimpleAsyncHTTPClient``.
2222

2323
New modules
2424
~~~~~~~~~~~
@@ -32,7 +32,7 @@ New modules
3232
* `tornado.process`: Multi-process mode has been improved, and can now restart
3333
crashed child processes. A new entry point has been added at
3434
`tornado.process.fork_processes`, although
35-
`tornado.httpserver.HTTPServer.start` is still supported.
35+
``tornado.httpserver.HTTPServer.start`` is still supported.
3636

3737
``tornado.web``
3838
~~~~~~~~~~~~~~~
@@ -54,12 +54,12 @@ New modules
5454
argument to set the ``max-age`` cookie attribute (note underscore vs dash)
5555
* `tornado.web.RequestHandler.set_default_headers` may be overridden to set
5656
headers in a way that does not get reset during error handling.
57-
* `RequestHandler.add_header` can now be used to set a header that can
57+
* `.RequestHandler.add_header` can now be used to set a header that can
5858
appear multiple times in the response.
59-
* `RequestHandler.flush` can now take a callback for flow control.
59+
* `.RequestHandler.flush` can now take a callback for flow control.
6060
* The ``application/json`` content type can now be gzipped.
6161
* The cookie-signing functions are now accessible as static functions
62-
`tornado.web.create_signed_value` and `tornado.web.decode_signed_value`.
62+
``tornado.web.create_signed_value`` and ``tornado.web.decode_signed_value``.
6363

6464
``tornado.httpserver``
6565
~~~~~~~~~~~~~~~~~~~~~~
@@ -70,7 +70,7 @@ New modules
7070
* The ``cookies`` property is now available on `tornado.httpserver.HTTPRequest`
7171
(it is also available in its old location as a property of
7272
`~tornado.web.RequestHandler`)
73-
* `tornado.httpserver.HTTPServer.bind` now takes a backlog argument with the
73+
* ``tornado.httpserver.HTTPServer.bind`` now takes a backlog argument with the
7474
same meaning as ``socket.listen``.
7575
* `~tornado.httpserver.HTTPServer` can now be run on a unix socket as well
7676
as TCP.
@@ -82,23 +82,23 @@ New modules
8282

8383
* `~tornado.iostream.IOStream` performance has been improved, especially for
8484
small synchronous requests.
85-
* New methods `tornado.iostream.IOStream.read_until_close` and
86-
`tornado.iostream.IOStream.read_until_regex`.
87-
* `IOStream.read_bytes` and `IOStream.read_until_close` now take a
85+
* New methods ``tornado.iostream.IOStream.read_until_close`` and
86+
``tornado.iostream.IOStream.read_until_regex``.
87+
* ``IOStream.read_bytes`` and ``IOStream.read_until_close`` now take a
8888
``streaming_callback`` argument to return data as it is received rather
8989
than all at once.
90-
* `IOLoop.add_timeout` now accepts `datetime.timedelta` objects in addition
90+
* `.IOLoop.add_timeout` now accepts `datetime.timedelta` objects in addition
9191
to absolute timestamps.
9292
* `~tornado.ioloop.PeriodicCallback` now sticks to the specified period
9393
instead of creeping later due to accumulated errors.
9494
* `tornado.ioloop.IOLoop` and `tornado.httpclient.HTTPClient` now have
9595
``close()`` methods that should be used in applications that create
9696
and destroy many of these objects.
97-
* `IOLoop.install` can now be used to use a custom subclass of IOLoop
97+
* `.IOLoop.install` can now be used to use a custom subclass of IOLoop
9898
as the singleton without monkey-patching.
9999
* `~tornado.iostream.IOStream` should now always call the close callback
100100
instead of the connect callback on a connection error.
101-
* The `IOStream` close callback will no longer be called while there
101+
* The `.IOStream` close callback will no longer be called while there
102102
are pending read callbacks that can be satisfied with buffered data.
103103

104104

@@ -112,7 +112,7 @@ New modules
112112
* The ``allow_nonstandard_methods`` flag on HTTP client requests now
113113
permits methods other than ``POST`` and ``PUT`` to contain bodies.
114114
* Fixed file descriptor leaks and multiple callback invocations in
115-
`SimpleAsyncHTTPClient`
115+
``SimpleAsyncHTTPClient``
116116
* No longer consumes extra connection resources when following redirects.
117117
* Now works with buggy web servers that separate headers with ``\n`` instead
118118
of ``\r\n\r\n``.
@@ -123,14 +123,14 @@ New modules
123123
Other modules
124124
~~~~~~~~~~~~~
125125

126-
* `tornado.auth.OpenIDMixin` now uses the correct realm when the
126+
* `tornado.auth.OpenIdMixin` now uses the correct realm when the
127127
callback URI is on a different domain.
128128
* `tornado.autoreload` has a new command-line interface which can be used
129129
to wrap any script. This replaces the ``--autoreload`` argument to
130130
`tornado.testing.main` and is more robust against syntax errors.
131131
* `tornado.autoreload.watch` can be used to watch files other than
132132
the sources of imported modules.
133-
* `tornado.database.Connection` has new variants of ``execute`` and
133+
* ``tornado.database.Connection`` has new variants of ``execute`` and
134134
``executemany`` that return the number of rows affected instead of
135135
the last inserted row id.
136136
* `tornado.locale.load_translations` now accepts any properly-formatted
@@ -156,7 +156,7 @@ Bug fixes
156156
and unquoted.
157157
* Multi-line headers are now supported.
158158
* Repeated Content-Length headers (which may be added by certain proxies)
159-
are now supported in `HTTPServer`.
159+
are now supported in `.HTTPServer`.
160160
* Unicode string literals now work in template expressions.
161161
* The template ``{% module %}`` directive now works even if applications
162162
use a template variable named ``modules``.

docs/releases/v2.2.0.rst

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Highlights
1515
Security fixes
1616
~~~~~~~~~~~~~~
1717

18-
* `tornado.simple_httpclient` now disables SSLv2 in all cases. Previously
18+
* ``tornado.simple_httpclient`` now disables SSLv2 in all cases. Previously
1919
SSLv2 would be allowed if the Python interpreter was linked against a
2020
pre-1.0 version of OpenSSL.
2121

@@ -26,7 +26,7 @@ Backwards-incompatible changes
2626
processes exit cleanly rather than returning ``None``. The old behavior
2727
was surprising and inconsistent with most of the documented examples
2828
of this function (which did not check the return value).
29-
* On Python 2.6, `tornado.simple_httpclient` only supports SSLv3. This
29+
* On Python 2.6, ``tornado.simple_httpclient`` only supports SSLv3. This
3030
is because Python 2.6 does not expose a way to support both SSLv3 and TLSv1
3131
without also supporting the insecure SSLv2.
3232
* `tornado.websocket` no longer supports the older "draft 76" version
@@ -36,30 +36,30 @@ Backwards-incompatible changes
3636
``tornado.httpclient``
3737
~~~~~~~~~~~~~~~~~~~~~~
3838

39-
* `SimpleAsyncHTTPClient` no longer hangs on ``HEAD`` requests,
39+
* ``SimpleAsyncHTTPClient`` no longer hangs on ``HEAD`` requests,
4040
responses with no content, or empty ``POST``/``PUT`` response bodies.
41-
* `SimpleAsyncHTTPClient` now supports 303 and 307 redirect codes.
42-
* `tornado.curl_httpclient` now accepts non-integer timeouts.
43-
* `tornado.curl_httpclient` now supports basic authentication with an
41+
* ``SimpleAsyncHTTPClient`` now supports 303 and 307 redirect codes.
42+
* ``tornado.curl_httpclient`` now accepts non-integer timeouts.
43+
* ``tornado.curl_httpclient`` now supports basic authentication with an
4444
empty password.
4545

4646
``tornado.httpserver``
4747
~~~~~~~~~~~~~~~~~~~~~~
4848

49-
* `HTTPServer` with ``xheaders=True`` will no longer accept
49+
* `.HTTPServer` with ``xheaders=True`` will no longer accept
5050
``X-Real-IP`` headers that don't look like valid IP addresses.
51-
* `HTTPServer` now treats the ``Connection`` request header as
51+
* `.HTTPServer` now treats the ``Connection`` request header as
5252
case-insensitive.
5353

5454
``tornado.ioloop`` and ``tornado.iostream``
5555
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5656

57-
* `IOStream.write` now works correctly when given an empty string.
58-
* `IOStream.read_until` (and ``read_until_regex``) now perform better
57+
* ``IOStream.write`` now works correctly when given an empty string.
58+
* ``IOStream.read_until`` (and ``read_until_regex``) now perform better
5959
when there is a lot of buffered data, which improves peformance of
60-
`SimpleAsyncHTTPClient` when downloading files with lots of
60+
``SimpleAsyncHTTPClient`` when downloading files with lots of
6161
chunks.
62-
* `SSLIOStream` now works correctly when ``ssl_version`` is set to
62+
* `.SSLIOStream` now works correctly when ``ssl_version`` is set to
6363
a value other than ``SSLv23``.
6464
* Idle ``IOLoops`` no longer wake up several times a second.
6565
* `tornado.ioloop.PeriodicCallback` no longer triggers duplicate callbacks
@@ -78,16 +78,16 @@ Backwards-incompatible changes
7878
~~~~~~~~~~~~~~~
7979

8080
* Now behaves better when given malformed ``Cookie`` headers
81-
* `RequestHandler.redirect` now has a ``status`` argument to send
81+
* `.RequestHandler.redirect` now has a ``status`` argument to send
8282
status codes other than 301 and 302.
83-
* New method `RequestHandler.on_finish` may be overridden for post-request
84-
processing (as a counterpart to `RequestHandler.prepare`)
85-
* `StaticFileHandler` now outputs ``Content-Length`` and ``Etag`` headers
83+
* New method `.RequestHandler.on_finish` may be overridden for post-request
84+
processing (as a counterpart to `.RequestHandler.prepare`)
85+
* `.StaticFileHandler` now outputs ``Content-Length`` and ``Etag`` headers
8686
on ``HEAD`` requests.
87-
* `StaticFileHandler` now has overridable ``get_version`` and
87+
* `.StaticFileHandler` now has overridable ``get_version`` and
8888
``parse_url_path`` methods for use in subclasses.
89-
* `RequestHandler.static_url` now takes an ``include_host`` parameter
90-
(in addition to the old support for the `RequestHandler.include_host`
89+
* `.RequestHandler.static_url` now takes an ``include_host`` parameter
90+
(in addition to the old support for the ``RequestHandler.include_host``
9191
attribute).
9292

9393
``tornado.websocket``
@@ -99,13 +99,13 @@ Backwards-incompatible changes
9999
* `tornado.websocket` no longer supports the older "draft 76" version
100100
of the websocket protocol by default, although this version can
101101
be enabled by overriding `tornado.websocket.WebSocketHandler.allow_draft76`.
102-
* `WebSocketHandler.write_message` now accepts a ``binary`` argument
102+
* `.WebSocketHandler.write_message` now accepts a ``binary`` argument
103103
to send binary messages.
104104
* Subprotocols (i.e. the ``Sec-WebSocket-Protocol`` header) are now supported;
105-
see the `WebSocketHandler.select_subprotocol` method for details.
106-
* `WebSocketHandler.get_websocket_scheme` can be used to select the
105+
see the `.WebSocketHandler.select_subprotocol` method for details.
106+
* `.WebSocketHandler.get_websocket_scheme` can be used to select the
107107
appropriate url scheme (``ws://`` or ``wss://``) in cases where
108-
`HTTPRequest.protocol` is not set correctly.
108+
``HTTPRequest.protocol`` is not set correctly.
109109

110110
Other modules
111111
~~~~~~~~~~~~~
@@ -126,5 +126,5 @@ Other modules
126126
* `tornado.testing.main` supports a new flag ``--exception_on_interrupt``,
127127
which can be set to false to make ``Ctrl-C`` kill the process more
128128
reliably (at the expense of stack traces when it does so).
129-
* `tornado.version_info` is now a four-tuple so official releases can be
129+
* ``tornado.version_info`` is now a four-tuple so official releases can be
130130
distinguished from development branches.

docs/releases/v2.2.1.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Security fixes
1111
values to protect against header injection, response splitting, etc.
1212
(it has always attempted to do this, but the check was incorrect).
1313
Note that redirects, the most likely source of such bugs, are protected
14-
by a separate check in `RequestHandler.redirect`.
14+
by a separate check in `.RequestHandler.redirect`.
1515

1616
Bug fixes
1717
~~~~~~~~~

docs/releases/v2.3.0.rst

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@ HTTP clients
88
~~~~~~~~~~~~
99

1010
* `tornado.httpclient.HTTPClient` now supports the same constructor
11-
keyword arguments as `AsyncHTTPClient`.
12-
* The ``max_clients`` keyword argument to `AsyncHTTPClient.configure` now works.
13-
* `tornado.simple_httpclient` now supports the ``OPTIONS`` and ``PATCH``
11+
keyword arguments as `.AsyncHTTPClient`.
12+
* The ``max_clients`` keyword argument to `.AsyncHTTPClient.configure` now works.
13+
* ``tornado.simple_httpclient`` now supports the ``OPTIONS`` and ``PATCH``
1414
HTTP methods.
15-
* `tornado.simple_httpclient` is better about closing its sockets
15+
* ``tornado.simple_httpclient`` is better about closing its sockets
1616
instead of leaving them for garbage collection.
17-
* `tornado.simple_httpclient` correctly verifies SSL certificates for
17+
* ``tornado.simple_httpclient`` correctly verifies SSL certificates for
1818
URLs containing IPv6 literals (This bug affected Python 2.5 and 2.6).
19-
* `tornado.simple_httpclient` no longer includes basic auth credentials
19+
* ``tornado.simple_httpclient`` no longer includes basic auth credentials
2020
in the ``Host`` header when those credentials are extracted from the URL.
21-
* `tornado.simple_httpclient` no longer modifies the caller-supplied header
21+
* ``tornado.simple_httpclient`` no longer modifies the caller-supplied header
2222
dictionary, which caused problems when following redirects.
23-
* `tornado.curl_httpclient` now supports client SSL certificates (using
23+
* ``tornado.curl_httpclient`` now supports client SSL certificates (using
2424
the same ``client_cert`` and ``client_key`` arguments as
25-
`tornado.simple_httpclient`)
25+
``tornado.simple_httpclient``)
2626

2727
HTTP Server
2828
~~~~~~~~~~~
2929

30-
* `HTTPServer` now works correctly with paths starting with ``//``
31-
* `HTTPHeaders.copy` (inherited from `dict.copy`) now works correctly.
32-
* `HTTPConnection.address` is now always the socket address, even for non-IP
33-
sockets. `HTTPRequest.remote_ip` is still always an IP-style address
30+
* `.HTTPServer` now works correctly with paths starting with ``//``
31+
* ``HTTPHeaders.copy`` (inherited from `dict.copy`) now works correctly.
32+
* ``HTTPConnection.address`` is now always the socket address, even for non-IP
33+
sockets. `.HTTPRequest.remote_ip` is still always an IP-style address
3434
(fake data is used for non-IP sockets)
3535
* Extra data at the end of multipart form bodies is now ignored, which fixes
3636
a compatibility problem with an iOS HTTP client library.
@@ -39,19 +39,19 @@ HTTP Server
3939
``IOLoop`` and ``IOStream``
4040
~~~~~~~~~~~~~~~~~~~~~~~~~~~
4141

42-
* `IOStream` now has an ``error`` attribute that can be used to determine
42+
* `.IOStream` now has an ``error`` attribute that can be used to determine
4343
why a socket was closed.
44-
* `tornado.iostream.IOStream.read_until` and ``read_until_regex`` are much
44+
* ``tornado.iostream.IOStream.read_until`` and ``read_until_regex`` are much
4545
faster with large input.
46-
* `IOStream.write` performs better when given very large strings.
47-
* `IOLoop.instance()` is now thread-safe.
46+
* ``IOStream.write`` performs better when given very large strings.
47+
* `.IOLoop.instance()` is now thread-safe.
4848

4949
``tornado.options``
5050
~~~~~~~~~~~~~~~~~~~
5151

5252
* `tornado.options` options with ``multiple=True`` that are set more than
5353
once now overwrite rather than append. This makes it possible to override
54-
values set in `parse_config_file` with `parse_command_line`.
54+
values set in ``parse_config_file`` with ``parse_command_line``.
5555
* `tornado.options` ``--help`` output is now prettier.
5656
* `tornado.options.options` now supports attribute assignment.
5757

@@ -71,20 +71,20 @@ HTTP Server
7171
``RequestHandler`` subclasses will need to be renamed.
7272
* `tornado.web.addslash` and ``removeslash`` decorators now send permanent
7373
redirects (301) instead of temporary (302).
74-
* `RequestHandler.flush` now invokes its callback whether there was any data
74+
* `.RequestHandler.flush` now invokes its callback whether there was any data
7575
to flush or not.
76-
* Repeated calls to `RequestHandler.set_cookie` with the same name now
76+
* Repeated calls to `.RequestHandler.set_cookie` with the same name now
7777
overwrite the previous cookie instead of producing additional copies.
78-
* `tornado.web.OutputTransform.transform_first_chunk` now takes and returns
78+
* ``tornado.web.OutputTransform.transform_first_chunk`` now takes and returns
7979
a status code in addition to the headers and chunk. This is a
8080
backwards-incompatible change to an interface that was never technically
8181
private, but was not included in the documentation and does not appear
8282
to have been used outside Tornado itself.
83-
* Fixed a bug on python versions before 2.6.5 when `URLSpec` regexes
83+
* Fixed a bug on python versions before 2.6.5 when `.URLSpec` regexes
8484
are constructed from unicode strings and keyword arguments are extracted.
8585
* The ``reverse_url`` function in the template namespace now comes from
86-
the `RequestHandler` rather than the `Application`. (Unless overridden,
87-
`RequestHandler.reverse_url` is just an alias for the `Application`
86+
the `.RequestHandler` rather than the `.Application`. (Unless overridden,
87+
`.RequestHandler.reverse_url` is just an alias for the `.Application`
8888
method).
8989
* The ``Etag`` header is now returned on 304 responses to an ``If-None-Match``
9090
request, improving compatibility with some caches.
@@ -98,14 +98,13 @@ Other modules
9898
in the url.
9999
* The ``extra_params`` argument to `tornado.escape.linkify` may now be
100100
a callable, to allow parameters to be chosen separately for each link.
101-
* `tornado.gen` no longer leaks `StackContexts` when a ``@gen.engine`` wrapped
101+
* `tornado.gen` no longer leaks ``StackContexts`` when a ``@gen.engine`` wrapped
102102
function is called repeatedly.
103103
* `tornado.locale.get_supported_locales` no longer takes a meaningless
104104
``cls`` argument.
105-
* `StackContext` instances now have a deactivation callback that can be
105+
* `.StackContext` instances now have a deactivation callback that can be
106106
used to prevent further propagation.
107107
* `tornado.testing.AsyncTestCase.wait` now resets its timeout on each call.
108108
* `tornado.wsgi.WSGIApplication` now parses arguments correctly on Python 3.
109109
* Exception handling on Python 3 has been improved; previously some exceptions
110-
such as `UnicodeDecodeError` would generate `TypeErrors`
111-
110+
such as `UnicodeDecodeError` would generate ``TypeErrors``

0 commit comments

Comments
 (0)