Skip to content

Commit d4954ef

Browse files
committed
some text amendments in docs
1 parent 6816c0b commit d4954ef

File tree

4 files changed

+18
-2
lines changed

4 files changed

+18
-2
lines changed

docs/abc.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ aiohttp.web is built on top of few concepts: *application*, *router*,
2222
from scratch, all other parts should work with new router seamlessly.
2323

2424
:class:`AbstractRouter` has the only mandatory method:
25-
:meth:`AbstractRouter.resolve` coroutine. It should return an
25+
:meth:`AbstractRouter.resolve` coroutine. It must return an
2626
:class:`AbstractMatchInfo` instance.
2727

2828
If the requested URL handler is found

docs/client.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ Resolving using custom nameservers
452452
----------------------------------
453453

454454
In order to specify the nameservers to when resolving the hostnames,
455-
aiodns is required::
455+
:term:`aiodns` is required::
456456

457457
from aiohttp.resolver import AsyncResolver
458458

docs/glossary.rst

+7
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@
88
.. if you add new entries, keep the alphabetical sorting!
99
1010
.. glossary::
11+
:sorted:
12+
13+
aiodns
14+
15+
DNS resolver for asyncio.
16+
17+
https://pypi.python.org/pypi/aiodns
1118

1219
asyncio
1320

docs/web_reference.rst

+9
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ like one using :meth:`Request.copy`.
4343

4444
Read-only :class:`str` property.
4545

46+
.. seealso:: :meth:`Application.make_handler`
47+
4648
.. attribute:: method
4749

4850
*HTTP method*, read-only property.
@@ -1095,6 +1097,13 @@ duplicated like one using :meth:`Application.copy`.
10951097
await loop.create_server(app.make_handler(),
10961098
'0.0.0.0', 8080)
10971099

1100+
``secure_proxy_ssl_header`` keyword parameter
1101+
can be used to detect request scheme::
1102+
1103+
await loop.create_server(app.make_handler(
1104+
secure_proxy_ssl_header='X-Forwarded-Proto'),
1105+
'0.0.0.0', 8080)
1106+
10981107
.. coroutinemethod:: shutdown()
10991108

11001109
A :ref:`coroutine<coroutine>` that should be called on

0 commit comments

Comments
 (0)