add error info to docstring

kevinheavey · Oct 2, 2024 · 8553116 · 8553116
1 parent c45b57a
commit 8553116
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/pubkey/src/lib.rs b/crates/pubkey/src/lib.rs
@@ -136,6 +136,9 @@ impl Pubkey {
     /// Returns:
     ///     Pubkey: The derived program address.
     ///
+    /// Raises:
+    ///     PubkeyError: if the resulting address is invalid.
+    ///
     /// Example:
     ///
     ///     >>> from solders.pubkey import Pubkey