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

Update docs #1283

Merged
merged 7 commits into from
Aug 22, 2024
Merged

Update docs #1283

merged 7 commits into from
Aug 22, 2024

Conversation

bmwant
Copy link
Contributor

@bmwant bmwant commented Aug 14, 2024

Changes

  • Add curl usage examples with http2
  • Add openssl certificate generation command
  • Fix readlines methods
  • Fix async/await syntax
  • Minor typos


$ curl --http2 https://nghttp2.org/httpbin/get

To use it with our server though, you will need to invoke it with a different
Copy link
Member

@Kriechi Kriechi Aug 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To use it with our server though, you will need to invoke it with a different
To use it with a ``python-hyper/h2``-based server, you can invoke it with a different

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this context I meant to use it with the server from this example, not any arbitrary hyper/h2-based server (as generally you will serve it with TLS), so you should or you have to is probably better.

@bmwant
Copy link
Contributor Author

bmwant commented Aug 18, 2024

@Kriechi addressed your concerns, still have one open regarding phrasing, but otherwise should be ready for another check

Co-authored-by: Thomas Kriechbaumer <[email protected]>
@bmwant bmwant requested a review from Kriechi August 18, 2024 12:32
@bmwant bmwant requested a review from Kriechi August 20, 2024 07:11
@Kriechi
Copy link
Member

Kriechi commented Aug 20, 2024

Thanks for making the changes! Looks good to me overall.

Seems the docs building with sphinx broke - likely unrelated to this PR though... I'll look into it in the next days, unless you beat me too it 😄

@bmwant
Copy link
Contributor Author

bmwant commented Aug 21, 2024

@Kriechi fixed tox -e docs by bumping Sphinx version used
Screenshot 2024-08-21 at 09 47 07

@Kriechi Kriechi merged commit 2730c5b into python-hyper:master Aug 22, 2024
9 checks passed
@Kriechi
Copy link
Member

Kriechi commented Aug 22, 2024

Thanks! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants