Skip to content

Commit 6de909e

Browse files
committed
Add a returns section to the docs on segwit::decode
We return a 3 element tuple but do not document what it is or the guarntees on the vector length. Do so.
1 parent 2b3f42f commit 6de909e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/segwit.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,10 @@ pub use {
6666

6767
/// Decodes a segwit address.
6868
///
69+
/// # Returns
70+
///
71+
/// The HRP, the witness version, and a guaranteed valid length witness program.
72+
///
6973
/// # Examples
7074
///
7175
/// ```

0 commit comments

Comments
 (0)