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

Explicitly document streams API #1106

Closed
asvetlov opened this issue Aug 22, 2016 · 1 comment · Fixed by #1150
Closed

Explicitly document streams API #1106

asvetlov opened this issue Aug 22, 2016 · 1 comment · Fixed by #1150
Labels

Comments

@asvetlov
Copy link
Member

http://aiohttp.readthedocs.io/en/stable/api.html looks like a piece of garbage.

Especially when I look on streaming API
http://aiohttp.readthedocs.io/en/stable/api.html#module-aiohttp.streams

It mixes native private methods like feed_eof() and feed_data() with decided to be used by top-level programmer like .read_any etc.
Moreover it doesn't suggest to use async for for iterating over incoming data and so on.

The doc should get rid of autodoc usage and switch to explicit documentation writing (as Python itself does).

The far blue sky goal is getting rid of autodoc usage at all for the project.

@lock
Copy link

lock bot commented Oct 29, 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.

@lock lock bot added the outdated label Oct 29, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Oct 29, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant