Skip to content

doc: amend description to point to CertificateParams for additional explanation #433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mcr wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: amend description to point to CertificateParams for additional explanation #433

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions rcgen/src/csr.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ impl PublicKeyData for PublicKey {
}

/// 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
Copy link
Copy Markdown
Member

@cpu cpu May 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be nicer to use intra-item rustdoc links for CertificateParams, KeyPair, SigningKey, and the ref'd methods.

/// and then calling serialize_request() or serialize_request_with_attributes() with a
/// KeyPair (or other SigningKey capable trait).
///
Copy link
Copy Markdown
Member

@cpu cpu May 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: the trailing /// without content doesn't seem necessary.

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct CertificateSigningRequest {
pub(crate) der: CertificateSigningRequestDer<'static>,
Expand Down
Loading