Skip to content
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

Move send and recieve doc tests to payjoindevkit.org #89

Open
DanGould opened this issue Jul 24, 2023 · 0 comments
Open

Move send and recieve doc tests to payjoindevkit.org #89

DanGould opened this issue Jul 24, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation website
Milestone

Comments

@DanGould
Copy link
Contributor

DanGould commented Jul 24, 2023

@jbesraa discovered the Documentation tests are broken because they're not written as Documentation tests should be

Either the tests should be moved out of the file's documentation and into a PDK example "Send and Receive Payjoin in Rust" like this one from LDK or be written according to documentation tests standards so they can be run in place. The main benefit of using documentation tests is that running them in place allows us to catch errors, but it seems we already have explicit integration tests to do that.

My preference would be a tutorial that we can link to from the docs. Here's the article from LDK in payjoindevkit.org repo that can be replaced and linked to by adding a line here

@DanGould DanGould added documentation Improvements or additions to documentation website labels Jul 24, 2023
@DanGould DanGould added this to the 1.0 milestone Jul 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation website
Projects
Status: Backlog
Development

No branches or pull requests

1 participant