frost/bdk
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix: Run README.md example on the CI

Browse Source 
Seems like `doc(include = "../README.md")` doesn't include the readme file as docs for the dummy struct. This might be due to a difference in Rust edition used back then or something
This commit is contained in:
meryacine 2022-07-08 15:08:22 +02:00
parent dd51380520
commit 9d2024434e
No known key found for this signature in database
GPG Key ID: C3BED6698142B393
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -95,6 +95,7 @@ use bdk::blockchain::ElectrumBlockchain;
use bdk::electrum_client::Client; use bdk::electrum_client::Client;
use bdk::wallet::AddressIndex::New; use bdk::wallet::AddressIndex::New;
use bitcoin::base64;
use bitcoin::consensus::serialize; use bitcoin::consensus::serialize;
fn main() -> Result<(), bdk::Error> { fn main() -> Result<(), bdk::Error> {
@ -131,6 +132,7 @@ fn main() -> Result<(), bdk::Error> {
```rust,no_run ```rust,no_run
use bdk::{Wallet, SignOptions, database::MemoryDatabase}; use bdk::{Wallet, SignOptions, database::MemoryDatabase};
use bitcoin::base64;
use bitcoin::consensus::deserialize; use bitcoin::consensus::deserialize;
fn main() -> Result<(), bdk::Error> { fn main() -> Result<(), bdk::Error> {
@ -154,7 +156,7 @@ fn main() -> Result<(), bdk::Error> {
### Unit testing ### Unit testing
``` ```bash
cargo test cargo test
``` ```
@ -162,7 +164,7 @@ cargo test
Integration testing require testing features, for example: Integration testing require testing features, for example:
``` ```bash
cargo test --features test-electrum cargo test --features test-electrum
``` ```

2
src/doctest.rs
View File

@ -9,6 +9,6 @@
// You may not use this file except in accordance with one or both of these // You may not use this file except in accordance with one or both of these
// licenses. // licenses.
#[doc(include = "../README.md")] #[doc = include_str!("../README.md")]
#[cfg(doctest)] #[cfg(doctest)]
pub struct ReadmeDoctests; pub struct ReadmeDoctests;