ConfigBuilder: expand documentation #1390
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
Codecov Report
@@ Coverage Diff @@
## main #1390 +/- ##
==========================================
- Coverage 96.35% 96.32% -0.03%
==========================================
Files 62 64 +2
Lines 14580 14734 +154
==========================================
+ Hits 14049 14193 +144
- Misses 531 541 +10
... and 16 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
De-emphasize the linker-friendliness in favor of explaining to the user what they need to do and in what order to do it. Explicitly explain the type parameters. Add separate intro sections for server and client. Shorten examples by using with_safe_defaults() in examples that aren't talking about protocol primitives.
jsha
force-pushed
the
jsha/configbuilder-doc-update
branch
from
029deca
to
4d975e7
Compare
ctz
approved these changes
Aug 7, 2023
cpu
approved these changes
Aug 7, 2023
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.
De-emphasize the linker-friendliness in favor of explaining to the user what they need to do and in what order to do it.
Explicitly explain the type parameters.
Add separate intro sections for server and client.
Shorten examples by using with_safe_defaults() in examples that aren't talking about protocol primitives.
After filing #1372 I wanted to see how far we could get in the current paradigm with more documentation.
Rendered: https://rustdoc.crud.net/jsha/configbuilder-doc/rustls/struct.ConfigBuilder.html