Skip to content

Clarify find_route Documentation#4421

Open
StephenChi-hi wants to merge 1 commit intolightningdevkit:mainfrom
StephenChi-hi:main
Open

Clarify find_route Documentation#4421
StephenChi-hi wants to merge 1 commit intolightningdevkit:mainfrom
StephenChi-hi:main

Conversation

@StephenChi-hi
Copy link

This PR improves the documentation for the find_route function in router.rs by:

  • Explaining how routes are constructed using the NetworkGraph and RouteParameters
  • Describing fee accumulation, CLTV expiry aggregation, and the influence of ScoreLookUp
  • Detailing the use of first_hops for outbound channel selection
  • Listing possible error conditions

These changes provide clearer guidance for users and developers on how route finding works and what to expect from the function.

Note

This is my part of my first set of open-source contribution as a developer. I appreciate the work behind this project and welcome any feedback or suggestions for improvement.

@ldk-reviews-bot
Copy link

ldk-reviews-bot commented Feb 16, 2026

I've assigned @tankyleo as a reviewer!
I'll wait for their review and will help manage the review process.
Once they submit their review, I'll check if a second reviewer would be helpful.

@codecov
Copy link

codecov bot commented Feb 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.06%. Comparing base (3497b59) to head (ed9e157).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4421      +/-   ##
==========================================
- Coverage   86.09%   86.06%   -0.03%     
==========================================
  Files         156      156              
  Lines      103623   103623              
  Branches   103623   103623              
==========================================
- Hits        89211    89187      -24     
- Misses      11895    11919      +24     
  Partials     2517     2517              
Flag Coverage Δ
tests 86.06% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants