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.

Sign up for GitHub

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

Jump to bottom

Proposed 0.11 docs #727

Merged
merged 20 commits into from
Jan 8, 2020
Merged

Proposed 0.11 docs #727

merged 20 commits into from
Jan 8, 2020

Conversation

tomchristie
Copy link
Member

There may well be a bunch of stuff still to think over here, but this is what I've got right now...

  • Docs changes for sync API.
  • Added new "async" section.
  • HTTP/2 listed as "async only"
  • Kept the UDS docs, listed as "async only" and moving it to the async section.
  • Advanced section now covers mounting WSGI apps, async-specific section covers mounting ASGI apps.

@tomchristie tomchristie added the docs Changes to the documentation label Jan 6, 2020
@tomchristie tomchristie added this to the 0.11.0 milestone Jan 6, 2020
@tomchristie tomchristie mentioned this pull request Jan 6, 2020
Closed
10 tasks
@florimondmanca florimondmanca self-requested a review January 7, 2020 12:02
florimondmanca
florimondmanca requested changes Jan 7, 2020
View reviewed changes
Copy link
Member

@florimondmanca florimondmanca left a comment

Choose a reason for hiding this comment

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

Left a bunch of suggestions :-)

README.md Outdated Show resolved Hide resolved
docs/advanced.md Outdated Show resolved Hide resolved
docs/advanced.md Outdated Show resolved Hide resolved
docs/async.md Outdated Show resolved Hide resolved
docs/async.md Outdated Show resolved Hide resolved
docs/async.md Outdated Show resolved Hide resolved
docs/async.md Outdated Show resolved Hide resolved
docs/async.md Outdated Show resolved Hide resolved
docs/async.md Outdated Show resolved Hide resolved
docs/quickstart.md Outdated Show resolved Hide resolved
tomchristie and others added 13 commits January 7, 2020 12:33
@tomchristie @florimondmanca
Update docs/advanced.md
cfdff55 
Co-Authored-By: Florimond Manca <[email protected]>
@tomchristie @florimondmanca
Update docs/async.md
cd40695 
Co-Authored-By: Florimond Manca <[email protected]>
@tomchristie @florimondmanca
Update docs/async.md
1f2dbf8 
Co-Authored-By: Florimond Manca <[email protected]>
@tomchristie @florimondmanca
Update docs/quickstart.md
15c3180 
Co-Authored-By: Florimond Manca <[email protected]>
@tomchristie @florimondmanca
Update docs/async.md
813d537 
Co-Authored-By: Florimond Manca <[email protected]>
@tomchristie @florimondmanca
Update docs/async.md
c3ae532 
Co-Authored-By: Florimond Manca <[email protected]>
@tomchristie @florimondmanca
Update docs/async.md
e5c5b62 
Co-Authored-By: Florimond Manca <[email protected]>
@tomchristie
Docs updates
0c7cf4e
@tomchristie
Use context-managed client instances in examples
1d51779
@tomchristie
Merge branch '0.11-docs' of https://github.com/encode/httpx into 0.11…
d8f36c6 
…-docs
@tomchristie
Merge branch 'master' into 0.11-docs
e133a91
@tomchristie
Update README with links to docs site, rather than to .md documents
f2bf757
@tomchristie
"99% test coverage"
7eb1af4
@tomchristie tomchristie mentioned this pull request Jan 8, 2020
Merged
2 tasks
florimondmanca
florimondmanca reviewed Jan 8, 2020
View reviewed changes
docs/api.md Outdated Show resolved Hide resolved
@florimondmanca
Copy link
Member

@tomchristie Also there are three pending comments that GitHub shows under "3 more items hidden", have you seen those?

@tomchristie
Copy link
Member Author

Thanks @florimondmanca! Nope, I'd not noticed those other suggestions.

The Client.close() API docs reference was waiting for #735 which is now in.

@tomchristie @florimondmanca
Update docs/async.md
c76aefd 
Co-Authored-By: Florimond Manca <[email protected]>
florimondmanca
florimondmanca approved these changes Jan 8, 2020
View reviewed changes
Copy link
Member

@florimondmanca florimondmanca left a comment

Choose a reason for hiding this comment

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

Looks good now! 🌈

@tomchristie
Copy link
Member Author

Fantastic, thanks! ✨

@tomchristie tomchristie merged commit 2038919 into master Jan 8, 2020
@tomchristie tomchristie deleted the 0.11-docs branch January 8, 2020 12:51
@tomchristie
Copy link
Member Author

Ah, I shoulda actually held off on merging this, since it updates the repo README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@florimondmanca florimondmanca florimondmanca approved these changes

Assignees
No one assigned
Labels
docs Changes to the documentation
Projects
None yet
Milestone
0.11.0
Development

Successfully merging this pull request may close these issues.
2 participants
@tomchristie @florimondmanca