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

Improve documentation and comments #8

Merged
merged 3 commits into from
Jan 29, 2021
Merged

Improve documentation and comments #8

merged 3 commits into from
Jan 29, 2021

Conversation

LukeShu
Copy link
Contributor

@LukeShu LukeShu commented Jan 29, 2021

  1. Improve the dhttp documentation and comments based on feedback from @kflynn on dhttp: A simple production-ready HTTP server library for the 2020s #6 .
  2. Add a "This is how it all fits together" example, based on the suggestion from @rhs.
  3. Talk about why dlib exists a bit more upfront, based on conversation with @rdl (hopefully this obviates some suggestions to clarify #7 ?)

@LukeShu LukeShu changed the title Lukeshu/docs Improve documentation and comments Jan 29, 2021
@richarddli
Copy link

LGTM!

rhs
rhs previously approved these changes Jan 29, 2021
View reviewed changes
Copy link
Contributor

@rhs rhs left a comment

Choose a reason for hiding this comment

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

Perfect, the example is exactly what I was looking for, this is awesome!

kflynn
kflynn previously approved these changes Jan 29, 2021
View reviewed changes
Copy link
Contributor

@kflynn kflynn left a comment

Choose a reason for hiding this comment

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

This definitely addresses my feedback -- thanks! Looks great. 🙂

I marked one typo for whenever you're in there next. Let's land this. 🙂

example_test.go Outdated Show resolved Hide resolved
@LukeShu LukeShu dismissed stale reviews from kflynn and rhs via 909a16e January 29, 2021 20:49
@LukeShu LukeShu requested a review from kflynn January 29, 2021 20:51
kflynn
kflynn approved these changes Jan 29, 2021
View reviewed changes
Copy link
Contributor

@kflynn kflynn left a comment

Choose a reason for hiding this comment

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

Hit it! and thanks. 🙂

@LukeShu LukeShu merged commit 4d6408f into master Jan 29, 2021
@LukeShu LukeShu deleted the lukeshu/docs branch January 29, 2021 20:56
@LukeShu LukeShu mentioned this pull request Feb 5, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kflynn kflynn kflynn approved these changes

@rhs rhs rhs left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@LukeShu @richarddli @rhs @kflynn