Update docs on PaymentFailureReason::RouteNotFound to add context

[TheBlueMatt]

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.

[coderabbitai]

Walkthrough

This update introduces a comprehensive enhancement to the documentation within a specific area of the codebase, focusing on the PaymentFailureReason enum. It particularly enriches the explanation for the RouteNotFound variant, providing a deeper understanding of its significance. This variant now clearly communicates that it represents a situation where all possible routing options have been exhausted after numerous unsuccessful attempts, offering better clarity for developers working with or debugging the payment routing logic.

Changes

File(s)	Change Summary
lightning/src/events/mod.rs	Added detailed explanation for RouteNotFound in PaymentFailureReason enum.

🐇✨
In the realm of code, where logic threads intertwine,
A rabbit hopped, leaving clarity behind.
"No route, no path," it said with a bound,
"Means all have been tried, but none could be found."
With each hop and skip, understanding grew,
In the garden of bytes, our knowledge anew.
🌟🐰

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 337b8de and a647883.

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.

[tnull]

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.