Skip to content

Commit

Permalink
Added shorter intro paragraphs to doc comments for clippy (#11492)
Browse files Browse the repository at this point in the history
  • Loading branch information
alex committed Sep 2, 2024
1 parent 95437ec commit bcbf0ad
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/rust/cryptography-x509-verification/src/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ use asn1::IA5String;
// RFC 2822 3.2.4
static ATEXT_CHARS: &str = "!#$%&'*+-/=?^_`{|}~";

/// Represents a DNS name can be used in X.509 name matching.
///
/// A `DNSName` is an `asn1::IA5String` with additional invariant preservations
/// per [RFC 5280 4.2.1.6], which in turn uses the preferred name syntax defined
/// in [RFC 1034 3.5] and amended in [RFC 1123 2.1].
Expand Down Expand Up @@ -100,6 +102,9 @@ impl PartialEq for DNSName<'_> {
}
}

/// Represents either a DNS name or a DNS wildcard for use in X.509 name
/// matching.
///
/// A `DNSPattern` represents a subset of the domain name wildcard matching
/// behavior defined in [RFC 6125 6.4.3]. In particular, all DNS patterns
/// must either be exact matches (post-normalization) *or* a single wildcard
Expand Down

0 comments on commit bcbf0ad

Please sign in to comment.