Document params of Application.make_handler().
#1132
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Current coverage is 98.28% (diff: 100%)@@ master #1132 diff @@
==========================================
Files 28 28
Lines 6465 6465
Methods 0 0
Messages 0 0
Branches 1083 1083
==========================================
Hits 6354 6354
Misses 61 61
Partials 50 50
|
|
@asvetlov Please check descriptions of parameters. I didn't find proper descriptions for some of them. Maybe you could point how to describe better. Also maybe we should drop some from the list.
|
| '0.0.0.0', 8080) | ||
| Creates HTTP protocol factory for handling requests. | ||
|
|
||
| :param handler: Request handler. Default: |
There was a problem hiding this comment.
Let's drop it from doc.
It's a hidden param, not part of public API (at least now now).
f0t0n
force-pushed
the
feature/doc-app-make-handler
branch
from
beb8af8 to
5736198
Compare
|
All the changes according to the comments in code review are done. |
- Dropped hidden parameters, and the code example for
`secure_proxy_ssl_header` according to code review notes.
f0t0n
force-pushed
the
feature/doc-app-make-handler
branch
from
5736198 to
9486c52
Compare
|
Thanks |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What do these changes do?
Explicitly document parameters of
aiohttp.web.Application.make_handler()method.Are there changes in behavior for the user?
Documentation became more clear.
Related issue number
#1129
Also see this thread: #1123 (comment)
Checklist