Use APIError::ChannelUnavailable a bit more for consistency

[rust-lightning] / src / util / errors.rs

diff --git a/src/util/errors.rs b/src/util/errors.rs
index 6513beefe794e82f9651e61b55739a5f7d8b651a..9446b35854baf9e34f665d3e1755ab7f599c4992 100644 (file)
--- a/src/util/errors.rs
+++ b/src/util/errors.rs
@@ -20,16 +20,15 @@ pub enum APIError {
                /// The feerate which was too high.
                feerate: u64
        },
-
-       /// Invalid route or parameters (cltv_delta, fee, pubkey) was specified
+       /// A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
+       /// too-many-hops, etc).
        RouteError {
                /// A human-readable error message
                err: &'static str
        },
-
-
-       /// We were unable to complete the request since channel is disconnected or
-       /// shutdown in progress initiated by remote
+       /// We were unable to complete the request as the Channel required to do so is unable to
+       /// complete the request (or was not found). This can take many forms, including disconnected
+       /// peer, channel at capacity, channel shutting down, etc.
        ChannelUnavailable {
                /// A human-readable error message
                err: &'static str