diff options
| author | RyanSquared <ryan@hashbang.sh> | 2024-01-21 22:10:37 -0500 |
|---|---|---|
| committer | Neal H. Walfield <neal@sequoia-pgp.org> | 2024-01-23 10:59:44 +0100 |
| commit | 99e9623c26c298fc99403202608803f86e3ac485 (patch) | |
| tree | b2aa4945c72b903d99603fdf7ad51e95744eb24f | |
| parent | b838d4b1bfc4b432e908741c94b336df19d201ad (diff) | |
openpgp: Fix the documentation for Key4::import_secret_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_secret_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 d0e62a5a..a7ea5dc1 100644 --- a/openpgp/src/packet/key.rs +++ b/openpgp/src/packet/key.rs @@ -1173,10 +1173,8 @@ impl<R> Key4<SecretParts, R> /// Creates a new OpenPGP secret key packet for an existing Ed25519 key. /// - /// 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 it's creation date set to - /// `ctime` or the current time if `None` is given. + /// The key will have it's creation date set to `ctime` or the current + /// time if `None` is given. pub fn import_secret_ed25519<T>(private_key: &[u8], ctime: T) -> Result<Self> where T: Into<Option<time::SystemTime>> { |