From 718cec7d85eb716ad5ba9bb85e112276c7db3e4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sosth=C3=A8ne=20Gu=C3=A9don?= Date: Tue, 28 Mar 2023 13:53:35 +0200 Subject: [PATCH] Improve documentation --- src/extension.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/extension.rs b/src/extension.rs index 5a655db..89befcf 100644 --- a/src/extension.rs +++ b/src/extension.rs @@ -119,9 +119,10 @@ pub trait AuthClient: ExtensionClient { }) } - /// Reset a pin. + /// Set a pin, resetting it's retry counter and setting the key to be wrapped /// /// Similar to [`set_pin`](AuthClient::set_pin), but allows the key that the pin will unwrap to be configured. + /// Currently only symmetric 256 bit keys are accepted. This method should be used only with keys that were obtained through [`get_pin_key`](AuthClient::get_pin_key) /// This allows for example backing up the key for a pin, to be able to restore it from another source. fn set_pin_with_key>( &mut self,