Skip to content

Commit 574eaa0

Browse files
committed
Add note regarding signAsynchronously
Motivation: `signAsynchronously` should not it is not mandatory to implement Modifications: Updated documentation Result: `signAsynchronously` has better docs
1 parent cc8da21 commit 574eaa0

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

Sources/X509/CustomPrivateKey.swift

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ public protocol CustomPrivateKey: Sendable, Hashable, PEMSerializable {
4545

4646
/// Use the private key to sign the provided bytes asynchronously with a given signature algorithm.
4747
///
48+
/// The default implementation calls ``signSynchronously(bytes:signatureAlgorithm:)`` and returns the result.
49+
/// Conforming types may override this method to provide a specialized asynchronous implementation.
50+
///
4851
/// - Parameters:
4952
/// - bytes: The data to create the signature for.
5053
/// - signatureAlgorithm: The signature algorithm to use.

0 commit comments

Comments
 (0)