diff options
| author | Neal H. Walfield <neal@sequoia-pgp.org> | 2024-01-23 10:57:32 +0100 |
|---|---|---|
| committer | Neal H. Walfield <neal@sequoia-pgp.org> | 2024-01-23 10:59:44 +0100 |
| commit | 4865e156d34a3e5604e1e2dbb42468151e30725a (patch) | |
| tree | 691217f706dc92d38094b4aa8dc6dfb2f0e3607f | |
| parent | 99e9623c26c298fc99403202608803f86e3ac485 (diff) | |
openpgp: Fix the documentation for Key4::import_public_ed25519.
- Ed25519 keys use the EdDSA signature algorithm, but the
documentation mentions parameters for ECDH.
- It appears that the documentation was copied from
`Key4::import_public_cv25519`, and not adjusted.
- Fix it.
| -rw-r--r-- | openpgp/src/packet/key.rs | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/openpgp/src/packet/key.rs b/openpgp/src/packet/key.rs index a7ea5dc1..118428fe 100644 --- a/openpgp/src/packet/key.rs +++ b/openpgp/src/packet/key.rs @@ -1074,10 +1074,8 @@ impl<R> Key4<key::PublicParts, R> /// Creates an OpenPGP public key packet from existing Ed25519 key /// material. /// - /// The ECDH key will use hash algorithm `hash` and symmetric - /// algorithm `sym`. If one or both are `None` secure defaults - /// will be used. The key will have its creation date set to - /// `ctime` or the current time if `None` is given. + /// The key will have its creation date set to `ctime` or the + /// current time if `None` is given. pub fn import_public_ed25519<T>(public_key: &[u8], ctime: T) -> Result<Self> where T: Into<Option<time::SystemTime>> { |