Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve middleware documentation #2852

Closed
asvetlov opened this issue Mar 19, 2018 · 6 comments
Closed

Improve middleware documentation #2852

asvetlov opened this issue Mar 19, 2018 · 6 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers outdated

Comments

@asvetlov
Copy link
Member

Current docs are not exhausting clean (#2848 for example).

https://docs.aiohttp.org/en/stable/web_advanced.html#middlewares section should have an example for middleware factory (a function that creates a middleware with passed arguments).

middleware factory conflicts with a factory for old-style middlewares, I think dropping old-styles from docs is ok (but we should support this old style for a while, #2851)

Document that normalize path middleware https://docs.aiohttp.org/en/stable/web_reference.html#normalize-path-middleware is actually a factory.

@asvetlov asvetlov added good first issue Good for newcomers documentation Improvements or additions to documentation labels Mar 19, 2018
@asvetlov
Copy link
Member Author

The issue is very easy, it is documentation update only.
We are looking for newbie for making a Pull Request

@code-cro
Copy link
Contributor

Hi,
"https://docs.aiohttp.org/en/stable/web_advanced.html#middlewares section should have an example for middleware factory (a function that creates a middleware with passed arguments)."

Is not that already explained here?

https://docs.aiohttp.org/en/stable/tutorial.html#middlewares

Or you mean on something else?

@asvetlov
Copy link
Member Author

I think web_advanced.rst should contain comprehensive description of middleware factory (a separate section maybe).
Mentioning in tutorial.rst is too brief and it's... tutorial, a different view on documentation.

@borisnaydis
Copy link
Contributor

@asvetlov please have a look on #2874.

@asvetlov
Copy link
Member Author

Fixed by #2874

@lock
Copy link

lock bot commented Oct 28, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a [new issue] for related bugs.
If you feel like there's important points made in this discussion, please include those exceprts into that [new issue].
[new issue]: https://github.com/aio-libs/aiohttp/issues/new

@lock lock bot added the outdated label Oct 28, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Oct 28, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers outdated
Projects
None yet
Development

No branches or pull requests

3 participants