docs: minor improvements to CryptoProvider doc #2353
Merged
Conversation
This file contains hidden or 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
brody4hire
commented
Feb 24, 2025
| @@ -120,7 +120,7 @@ pub use crate::suites::CipherSuiteCommon; | |||
| /// provider (dynamically). | |||
| /// | |||
| /// For example, if we want to make a provider that just overrides key loading in the config builder | |||
| /// API ([`ConfigBuilder::with_single_cert`] etc.), it might look like this: | |||
| /// API (with [`ConfigBuilder::with_single_cert`], etc.), it might look like this: | |||
There was a problem hiding this comment.
Without these updates, the line seems to breaks right after API ( in my browser.
With these updates, the line seems to break after API (with in my browser.
I think this is a slight improvement, wonder if anyone can think of something better for this.
brody4hire
commented
Feb 24, 2025
| @@ -212,7 +212,7 @@ pub struct CryptoProvider { | |||
| /// Source of cryptographically secure random numbers. | |||
| pub secure_random: &'static dyn SecureRandom, | |||
|
|
|||
| /// Provider for loading private [SigningKey]s from [PrivateKeyDer]. | |||
| /// Provider for loading private [`SigningKey`]s from [`PrivateKeyDer`]. | |||
There was a problem hiding this comment.
When I try cargo doc in my local machine, which is mac M2, it renders [PrivateKeyDer] with no link. I suspect that this is because docs for rustls-pki-types are rendered with no platform support for arm(64). I am pretty surprised as rustls-pki-types seems to be supported for all major platforms.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2353 +/- ##
=======================================
Coverage 94.89% 94.89%
=======================================
Files 103 103
Lines 24274 24274
=======================================
Hits 23034 23034
Misses 1240 1240 ☔ View full report in Codecov by Sentry. |
djc
approved these changes
Feb 24, 2025
Benchmark resultsInstruction countsSignificant differencesThere are no significant instruction count differences Other differencesClick to expand
Wall-timeSignificant differencesThere are no significant wall-time differences Other differencesClick to expand
Additional informationCheckout details:
|
|
I just pushed another update, guessing it will miss the merge queue. I guess I will open another PR for this. |
brody4hire
commented
Feb 24, 2025
| @@ -110,7 +110,7 @@ pub use crate::suites::CipherSuiteCommon; | |||
| /// | |||
| /// # Making a custom `CryptoProvider` | |||
| /// | |||
| /// Your goal will be to populate a [`crypto::CryptoProvider`] struct instance. | |||
| /// Your goal will be to populate an instance of this [`crypto::CryptoProvider`] struct. | |||
There was a problem hiding this comment.
I would like to do this update a little differently, thankfully it missed the merge queue. I would like to remove the brackets, as it seems pretty useless for this page to reference itself here. Using CryptoProvider with no brackets also seems more consistent with how this is done elsewhere for CryptoProvider in the documentation. PR should be coming soon.
UPDATE NOW PROPOSED - #2355
2 tasks
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.
STATUS: I think this should be ready for review. I made comments on a couple things I noticed, don't think they should be blocking. Thanks.