doc: amend description to point to CertificateParams for additional explanation#433
Open
mcr wants to merge 1 commit into
Open
doc: amend description to point to CertificateParams for additional explanation#433mcr wants to merge 1 commit into
mcr wants to merge 1 commit into
Conversation
cpu
reviewed
May 26, 2026
Member
cpu
left a comment
cpu
left a comment
There was a problem hiding this comment.
Thanks for the PR. I think it's a good idea but had nits to consider for the impl.
| /// A new certificate signing request is created by filling out a CertificateParams object | ||
| /// and then calling serialize_request() or serialize_request_with_attributes() with a | ||
| /// KeyPair (or other SigningKey capable trait). | ||
| /// |
Member
There was a problem hiding this comment.
Nit: the trailing /// without content doesn't seem necessary.
|
|
||
| /// A certificate signing request (CSR) that can be encoded to PEM or DER. | ||
| /// | ||
| /// A new certificate signing request is created by filling out a CertificateParams object |
Member
There was a problem hiding this comment.
I think it would be nicer to use intra-item rustdoc links for CertificateParams, KeyPair, SigningKey, and the ref'd methods.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
amend CertificateSigningRequest documentation to more clearly point at CertificateParams as the way to generate a new CSR with attributes.
[In the future, building one from a CSR attributes (RFC9908) object will be contributed]