From 8b1a9d251820a9ed47c1584e9fd6d5c0c6eeca7a Mon Sep 17 00:00:00 2001
From: Riccardo Casatta <riccardo@casatta.it>
Date: Fri, 4 Dec 2020 15:59:39 +0100
Subject: [PATCH] [docs] descriptor/error.rs

---
 src/descriptor/error.rs | 30 ++++++++++++++++++------------
 1 file changed, 18 insertions(+), 12 deletions(-)

diff --git a/src/descriptor/error.rs b/src/descriptor/error.rs
index 14c5d8cc..151487da 100644
--- a/src/descriptor/error.rs
+++ b/src/descriptor/error.rs
@@ -27,29 +27,35 @@
 /// Errors related to the parsing and usage of descriptors
 #[derive(Debug)]
 pub enum Error {
-    InternalError,
-    InvalidPrefix(Vec<u8>),
-    HardenedDerivationOnXpub,
-    MalformedInput,
+    //InternalError,
+    //InvalidPrefix(Vec<u8>),
+    //HardenedDerivationOnXpub,
+    //MalformedInput,
+    /// Invalid HD Key path, such as having a wildcard but a length != 1
     InvalidHDKeyPath,
 
-    KeyParsingError(String),
+    //KeyParsingError(String),
+    #[allow(missing_docs)]
     Key(crate::keys::KeyError),
-
+    #[allow(missing_docs)]
     Policy(crate::descriptor::policy::PolicyError),
 
-    InputIndexDoesntExist,
-    MissingPublicKey,
-    MissingDetails,
-
+    //InputIndexDoesntExist,
+    //MissingPublicKey,
+    //MissingDetails,
+    /// Invalid character found in the descriptor checksum
     InvalidDescriptorCharacter(char),
 
-    CantDeriveWithMiniscript,
-
+    //CantDeriveWithMiniscript,
+    #[allow(missing_docs)]
     BIP32(bitcoin::util::bip32::Error),
+    #[allow(missing_docs)]
     Base58(bitcoin::util::base58::Error),
+    #[allow(missing_docs)]
     PK(bitcoin::util::key::Error),
+    #[allow(missing_docs)]
     Miniscript(miniscript::Error),
+    #[allow(missing_docs)]
     Hex(bitcoin::hashes::hex::Error),
 }