Skip to content

Document Uri with parse/version/sender example #1184

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document Uri with parse/version/sender example #1184

wants to merge 1 commit into from

Conversation

@Mshehu5
Copy link
Contributor

@Mshehu5 Mshehu5 commented Oct 30, 2025

This PR address some issues in #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:

@coveralls
Copy link
Collaborator

coveralls commented Oct 30, 2025 •
edited
Loading

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

@Mshehu5 Mshehu5 marked this pull request as draft October 30, 2025 13:24
@Mshehu5
Document Uri with parse/version/sender example
a2e766a 
Add  docs clarifying the `bitcoin_uri` and Pjuri.
Include an example that parses a Payjoin URI, checks version, and
initializes the sender state machine. Docs-only; no code changes.
@Mshehu5 Mshehu5 marked this pull request as ready for review October 30, 2025 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Mshehu5 @coveralls