Skip to content

Commit

Permalink
Drop stale versionadded/versionchanged
Browse files Browse the repository at this point in the history
  • Loading branch information
asvetlov committed Nov 10, 2017
1 parent 25e45f5 commit 6fdf4e4
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 112 deletions.
93 changes: 8 additions & 85 deletions docs/client_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ Usage example::
loop.run_until_complete(main(loop))


.. versionadded:: 0.17

The client session supports the context manager protocol for self closing.

.. class:: ClientSession(*, connector=None, loop=None, cookies=None, \
Expand Down Expand Up @@ -93,8 +91,6 @@ The client session supports the context manager protocol for self closing.

:param version: supported HTTP version, ``HTTP 1.1`` by default.

.. versionadded:: 0.21

:param cookie_jar: Cookie Jar, :class:`AbstractCookieJar` instance.

By default every session instance has own private cookie jar for
Expand All @@ -108,8 +104,6 @@ The client session supports the context manager protocol for self closing.
:class:`aiohttp.helpers.DummyCookieJar` instance can be
provided.

.. versionadded:: 0.22

:param callable json_serialize: Json *serializer* callable.

By default :func:`json.dumps` function.
Expand Down Expand Up @@ -170,8 +164,6 @@ The client session supports the context manager protocol for self closing.

A read-only property.

.. versionadded:: 1.0

.. attribute:: requote_redirect_url

aiohttp re quote's redirect urls by default, but some servers
Expand Down Expand Up @@ -305,16 +297,6 @@ The client session supports the context manager protocol for self closing.
:return ClientResponse: a :class:`client response <ClientResponse>`
object.

.. versionadded:: 1.0

Added ``proxy`` and ``proxy_auth`` parameters.

Added ``timeout`` parameter.

.. versionchanged:: 1.1

URLs may be either :class:`str` or :class:`~yarl.URL`

.. comethod:: get(url, *, allow_redirects=True, **kwargs)
:async-with:
:coroutine:
Expand All @@ -333,10 +315,6 @@ The client session supports the context manager protocol for self closing.
:return ClientResponse: a :class:`client response
<ClientResponse>` object.

.. versionchanged:: 1.1

URLs may be either :class:`str` or :class:`~yarl.URL`

.. comethod:: post(url, *, data=None, **kwargs)
:async-with:
:coroutine:
Expand All @@ -356,10 +334,6 @@ The client session supports the context manager protocol for self closing.
:return ClientResponse: a :class:`client response
<ClientResponse>` object.

.. versionchanged:: 1.1

URLs may be either :class:`str` or :class:`~yarl.URL`

.. comethod:: put(url, *, data=None, **kwargs)
:async-with:
:coroutine:
Expand All @@ -379,10 +353,6 @@ The client session supports the context manager protocol for self closing.
:return ClientResponse: a :class:`client response
<ClientResponse>` object.

.. versionchanged:: 1.1

URLs may be either :class:`str` or :class:`~yarl.URL`

.. comethod:: delete(url, **kwargs)
:async-with:
:coroutine:
Expand All @@ -398,10 +368,6 @@ The client session supports the context manager protocol for self closing.
:return ClientResponse: a :class:`client response
<ClientResponse>` object.

.. versionchanged:: 1.1

URLs may be either :class:`str` or :class:`~yarl.URL`

.. comethod:: head(url, *, allow_redirects=False, **kwargs)
:async-with:
:coroutine:
Expand All @@ -420,10 +386,6 @@ The client session supports the context manager protocol for self closing.
:return ClientResponse: a :class:`client response
<ClientResponse>` object.

.. versionchanged:: 1.1

URLs may be either :class:`str` or :class:`~yarl.URL`

.. comethod:: options(url, *, allow_redirects=True, **kwargs)
:async-with:
:coroutine:
Expand All @@ -443,10 +405,6 @@ The client session supports the context manager protocol for self closing.
:return ClientResponse: a :class:`client response
<ClientResponse>` object.

.. versionchanged:: 1.1

URLs may be either :class:`str` or :class:`~yarl.URL`

.. comethod:: patch(url, *, data=None, **kwargs)
:async-with:
:coroutine:
Expand All @@ -466,10 +424,6 @@ The client session supports the context manager protocol for self closing.
:return ClientResponse: a :class:`client response
<ClientResponse>` object.

.. versionchanged:: 1.1

URLs may be either :class:`str` or :class:`~yarl.URL`

.. comethod:: ws_connect(url, *, protocols=(), timeout=10.0,\
receive_timeout=None,\
auth=None,\
Expand Down Expand Up @@ -654,10 +608,6 @@ certification chaining.
assert resp.status == 200
print(await resp.text())

.. versionchanged:: 1.1

URLs may be either :class:`str` or :class:`~yarl.URL`


.. _aiohttp-client-reference-connectors:

Expand Down Expand Up @@ -727,8 +677,6 @@ BaseConnector
Read-only property, ``True`` if connector should ultimately
close connections on releasing.

.. versionadded:: 0.16

.. attribute:: limit

The total number for simultaneous connections.
Expand Down Expand Up @@ -809,8 +757,6 @@ TCPConnector

Note: use of MD5 or SHA1 digests is insecure and deprecated.

.. versionadded:: 0.16

.. deprecated:: 2.3

Pass *verify_ssl* to ``ClientSession.get()`` etc.
Expand All @@ -822,12 +768,6 @@ TCPConnector
establishing a bit but may introduce some
*side effects* also.

.. versionadded:: 0.17

.. versionchanged:: 1.0

The default is changed to ``True``

:param int ttl_dns_cache: expire after some seconds the DNS entries, ``None``
means cached forever. By default 10 seconds.

Expand All @@ -853,22 +793,19 @@ TCPConnector
Custom resolvers allow to resolve hostnames differently than the
way the host is configured.

.. versionchanged:: 1.1

The resolver is ``aiohttp.ThreadedResolver`` by default,
asynchronous version is not pretty robust but might fail in
very rare cases.
The resolver is ``aiohttp.ThreadedResolver`` by default,
asynchronous version is pretty robust but might fail in
very rare cases.

:param int family: TCP socket family, both IPv4 and IPv6 by default.
For *IPv4* only use :const:`socket.AF_INET`,
for *IPv6* only -- :const:`socket.AF_INET6`.

.. versionchanged:: 0.18

*family* is `0` by default, that means both IPv4 and IPv6 are
accepted. To specify only concrete version please pass
:const:`socket.AF_INET` or :const:`socket.AF_INET6`
explicitly.
*family* is ``0`` by default, that means both
IPv4 and IPv6 are accepted. To specify only
concrete version please pass
:const:`socket.AF_INET` or
:const:`socket.AF_INET6` explicitly.

:param ssl.SSLContext ssl_context: SSL context used for processing
*HTTPS* requests (optional).
Expand All @@ -879,8 +816,6 @@ TCPConnector
:param tuple local_addr: tuple of ``(local_host, local_port)`` used to bind
socket locally if specified.

.. versionadded:: 0.21

:param bool force_close: close underlying sockets after
connection releasing (optional).

Expand Down Expand Up @@ -912,16 +847,12 @@ TCPConnector

Read-only :class:`bool` property.

.. versionadded:: 0.17

.. attribute:: cached_hosts

The cache of resolved hosts if :attr:`dns_cache` is enabled.

Read-only :class:`types.MappingProxyType` property.

.. versionadded:: 0.17

.. attribute:: fingerprint

MD5, SHA1, or SHA256 hash of the expected certificate in DER
Expand All @@ -930,17 +861,13 @@ TCPConnector

Read-only :class:`bytes` property.

.. versionadded:: 0.16

.. method:: clear_dns_cache(self, host=None, port=None)

Clear internal *DNS* cache.

Remove specific entry if both *host* and *port* are specified,
clear all cache otherwise.

.. versionadded:: 0.17


UnixConnector
^^^^^^^^^^^^^
Expand Down Expand Up @@ -1039,10 +966,6 @@ Response object
After exiting from ``async with`` block response object will be
*released* (see :meth:`release` coroutine).

.. versionadded:: 0.18

Support for ``async with``.

.. attribute:: version

Response's version, :class:`HttpVersion` instance.
Expand Down
10 changes: 5 additions & 5 deletions docs/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ functionality, the AioHTTPTestCase is provided::

an aiohttp test server, :class:`TestServer` instance.

.. versionadded:: 2.3.0
.. versionadded:: 2.3

.. attribute:: loop

Expand All @@ -265,7 +265,7 @@ functionality, the AioHTTPTestCase is provided::

:return: :class:`TestClient` instance.

.. versionadded:: 2.3.0
.. versionadded:: 2.3

.. comethod:: get_server()

Expand All @@ -274,7 +274,7 @@ functionality, the AioHTTPTestCase is provided::

:return: :class:`TestServer` instance.

.. versionadded:: 2.3.0
.. versionadded:: 2.3

.. comethod:: get_application()

Expand All @@ -289,14 +289,14 @@ functionality, the AioHTTPTestCase is provided::
This async method do nothing by default and can be overridden to execute
asynchronous code during the ``setUp`` stage of the ``TestCase``.

.. versionadded:: 2.3.0
.. versionadded:: 2.3

.. comethod:: tearDownAsync()

This async method do nothing by default and can be overridden to execute
asynchronous code during the ``tearDown`` stage of the ``TestCase``.

.. versionadded:: 2.3.0
.. versionadded:: 2.3

.. method:: setUp()

Expand Down
22 changes: 0 additions & 22 deletions docs/web.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,6 @@ family are plain shortcuts for :meth:`UrlDispatcher.add_route`.

:ref:`aiohttp-router-refactoring-021` for more details

.. versionadded:: 0.21.0

Introduce resources.


.. _aiohttp-web-variable-handler:

Expand Down Expand Up @@ -307,20 +303,6 @@ viewed using the :meth:`UrlDispatcher.named_resources` method::
print(name, resource)



.. versionadded:: 0.18
:meth:`UrlDispatcher.routes`

.. versionadded:: 0.19
:meth:`UrlDispatcher.named_routes`

.. deprecated:: 0.21

Use :meth:`UrlDispatcher.named_resources` /
:meth:`UrlDispatcher.resources` instead of
:meth:`UrlDispatcher.named_routes` / :meth:`UrlDispatcher.routes`.


.. _aiohttp-web-alternative-routes-definition:

Alternative ways for registering routes
Expand Down Expand Up @@ -1143,8 +1125,6 @@ exception.
Signals
-------

.. versionadded:: 0.18

Although :ref:`middlewares <aiohttp-web-middlewares>` can customize
:ref:`request handlers<aiohttp-web-handler>` before or after a :class:`Response`
has been prepared, they can't customize a :class:`Response` **while** it's
Expand Down Expand Up @@ -1379,8 +1359,6 @@ Custom resource implementation
To register custom resource use :meth:`UrlDispatcher.register_resource`.
Resource instance must implement `AbstractResource` interface.

.. versionadded:: 1.2.1


.. _aiohttp-web-graceful-shutdown:

Expand Down

0 comments on commit 6fdf4e4

Please sign in to comment.