awc: improve module documentation #1656
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robjtede
added
A-awc
popzxc
force-pushed
the
awc-better-docs
branch
from
7d99365
to
2ce66b5
Compare
robjtede
changed the title
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Neopallium
reviewed
Sep 9, 2020
Neopallium
approved these changes
Sep 9, 2020
Codecov Report
@@ Coverage Diff @@
## master #1656 +/- ##
=======================================
Coverage 53.35% 53.35%
=======================================
Files 117 117
Lines 11813 11813
=======================================
Hits 6303 6303
Misses 5510 5510
Continue to review full report at Codecov.
|
robjtede
requested changes
Sep 9, 2020
Improve wording Co-authored-by: Rob Ede <robjtede@icloud.com>
popzxc
force-pushed
the
awc-better-docs
branch
from
0360467
to
62aaf1f
Compare
robjtede
requested changes
Sep 9, 2020
Fair enough. We'll merge with this and I shall try to remember to change them back to HTTPS before stable release. We should get this working on Windows. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Type
Docs
PR Checklist
Check your PR fulfills the following:
Overview
Subjectively, one great part of
reqwestis its documentation, which provides usage examples for most common users' needs right on the main page ofdocs.rs.This PR extends the `awc main doc-comment with the similar list of examples, so that users can see how to use library without digging deep into the crate docs (or even the source code).