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

Document working with connections directly. #725

Open
tomchristie opened this issue Jun 14, 2023 · 0 comments
Open

Document working with connections directly. #725

tomchristie opened this issue Jun 14, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@tomchristie
Copy link
Member

We expose the following through our public API...

  • HTTPConnection / AsyncHTTPConnection
  • HTTP11Connection / AsyncHTTP11Connection
  • HTTP2Connection / AsyncHTTP2Connection

However we don't have them publicly documented.

Users wouldn't typically need to work directly with connections since you normally want to be sending requests at the level of the connection pool, but it'd be really valuable for us to document this layer of the API.

With a similar motivation to our docs & API work on #699, helping expose the API layering in httpcore is valuable because it demonstrates how the various parts fit together & allows users to isolate issues more clearly.

@tomchristie tomchristie added the documentation Improvements or additions to documentation label Jun 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant