-
Notifications
You must be signed in to change notification settings - Fork 405
Update docs on PaymentFailureReason::RouteNotFound
to add context
#2915
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update docs on PaymentFailureReason::RouteNotFound
to add context
#2915
Conversation
tnull noted on discord that its somewhat unclear to users what `RouteNotFound` actually means - that we ran out of routes, rather than could not find a route at all - so the docs are updated here.
WalkthroughThis update introduces a comprehensive enhancement to the documentation within a specific area of the codebase, focusing on the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- lightning/src/events/mod.rs (1 hunks)
Additional comments: 1
lightning/src/events/mod.rs (1)
- 371-374: The documentation for
PaymentFailureReason::RouteNotFound
has been updated to clarify that this error signifies the exhaustion of all available routes after multiple failed attempts, rather than the inability to find any route at all. This change aligns with the PR's objective to provide a clearer understanding of the error, which should help reduce confusion for users and developers dealing with payment failures in the system.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, surely an improvement.
I think in the future we should consider returning more expressive errors from find_route
to indicate why exactly (or most likely) finding a route failed.
tnull noted on discord that its somewhat unclear to users what
RouteNotFound
actually means - that we ran out of routes, rather than could not find a route at all - so the docs are updated here.