Small doc tweaks #1658
Merged
Small doc tweaks #1658
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1658 +/- ##
=======================================
Coverage 95.90% 95.90%
=======================================
Files 78 78
Lines 16083 16083
=======================================
Hits 15424 15424
Misses 659 659 ☔ View full report in Codecov by Sentry. |
ctz
reviewed
Dec 1, 2023
cpu
force-pushed
the
cpu-doc-tweaks
branch
2 times, most recently
from
2afdba0
to
34ff930
Compare
djc
reviewed
Dec 1, 2023
cpu
force-pushed
the
cpu-doc-tweaks
branch
2 times, most recently
from
a8e163e
to
9d17051
Compare
ctz
approved these changes
Dec 1, 2023
Also link to the crate.
* Use their proper filenames, with the `-mio` suffix. * Link to `mio` crate.
Consistently describe te default features, include that *ring* is default enabled.
This puts ring, aws-lc-rs, and the tls12 features up front. They're likely more interesting than the logging and read_buf features that are increasingly niche.
This type appears in the 'crypto' mod docs without any accompanying text. This commit adds some.
Also drops "as a value".
djc
approved these changes
Dec 1, 2023
|
Thanks for the reviews! |
|
I've pushed updated docs, generated on the latest |
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.
Some small fixes from trying to do a bit of a read-through of the docs. Best reviewed commit-by-commit.