Merge #158: Add a returns section to the docs on segwit::decode

6de909e Add a returns section to the docs on segwit::decode (Tobin C. Harding)

Pull request description:

  We return a 3 element tuple but do not document what it is or the guarntees on the vector length. Do so.

ACKs for top commit:
  Kixunil:
    ACK 6de909e
  apoelstra:
    ACK 6de909e

Tree-SHA512: e9c5713306906081d996df3b0dee3444ffd1d41f4d54b693be285c3a7e0a2351d1f1054dd37702879d4ac9cdace27164a24684f534b84bc7f0f9d15d7d30289a

Author: apoelstra

src/segwit.rs

@@ -66,6 +66,10 @@ pub use {
 
 /// Decodes a segwit address.
 ///
+/// # Returns
+///
+/// The HRP, the witness version, and a guaranteed valid length witness program.
+///
 /// # Examples
 ///
 /// ```