Merge pull request #64 from eopb/push-kqoxpuzqzmry

docs: update for `SerializableSecret`
eopb · May 11, 2024 · 65e570c · 65e570c
2 parents 50dbf86 + e825219
commit 65e570c
Showing 1 changed file with 2 additions and 5 deletions.
diff --git a/src/serde.rs b/src/serde.rs
@@ -12,11 +12,8 @@ impl<'de, T: Deserialize<'de>> Deserialize<'de> for Secret<T> {
 
 /// A serializable type that contains a secret.
 ///
-/// This abstraction enables [expose_secret] to be used to serialize both `Secret<T>` and
-/// `Option<Secret<T>>`.
-///
-/// This type is currently private. If you feel that a public `SerializableSecret` could
-/// be useful for your use case please open a PR :)
+/// This abstraction enables [expose_secret] to be used to serialize both `Secret<T>`, `&Secret<T>`
+/// and `Option<Secret<T>>`.
 pub trait SerializableSecret<T> {
     type Exposed<'a>: Serialize
     where