rust-payjoin icon indicating copy to clipboard operation
rust-payjoin copied to clipboard

Document Uri with parse/version/sender example

Open Mshehu5 opened this issue 2 months ago • 1 comments

This PR address some issues in https://github.com/payjoin/rust-payjoin/issues/865 mainly this issue :

Document the Uri top level type alias and struct documentation for the individual fields exists but this assumes the reader is familiar with the Extras pattern of bitcoin_uri it should have an example of parsing a URI checking the version, and initializing sender state machine

consulted GPT codex for example

Pull Request Checklist

Please confirm the following before requesting review:

Mshehu5 avatar Oct 30 '25 13:10 Mshehu5

Pull Request Test Coverage Report for Build 18942206385

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 83.578%

Totals Coverage Status
Change from base Build 18915517369: 0.0%
Covered Lines: 8988
Relevant Lines: 10754

💛 - Coveralls

coveralls avatar Oct 30 '25 13:10 coveralls