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

Add doc comment #250

Merged
merged 7 commits into from
May 27, 2019
Merged

Add doc comment #250

merged 7 commits into from
May 27, 2019

Conversation

k-nasa
Copy link
Contributor

@k-nasa k-nasa commented May 21, 2019

Description

I added a document.
I think that there is an inappropriate expression or wording, or an error in English, so please give me a review.

Motivation and Context

close: #244

How Has This Been Tested?

I generated a document and confirmed that there was no warning

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link
Contributor

@prasannavl prasannavl left a comment

Choose a reason for hiding this comment

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

Thanks for this @k-nasa! Some of this conflicts with the recent #252 and the upcoming #255. I also added some doc (but only the crate level ones) during the restructure. Would you be willing to rebase after that?

Or alternatively, since you had done this before #255 if you could just rebase it on master, I can rebase #255 over this.

@k-nasa
Copy link
Contributor Author

k-nasa commented May 23, 2019

@prasannavl It seems that #255 has been approved. I will rebase after merge #255.

@fairingrey
Copy link
Contributor

@k-nasa #255 was merged, feel free to rebase this whenever 👍

@k-nasa
Copy link
Contributor Author

k-nasa commented May 25, 2019

@fairingrey I did rebase! Please give a review if you have time. 🙏

Copy link
Member

@yoshuawuyts yoshuawuyts left a comment

Choose a reason for hiding this comment

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

Fantastic, thanks!

@yoshuawuyts yoshuawuyts merged commit 279e0f0 into http-rs:master May 27, 2019
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.

Fix documentation and add warn(missing_docs) to all crates
4 participants