Skip to content

Conversation

@storopoli
Copy link
Contributor

There is a missing hide comment # in one of the use statements.

There is a missing hide comment `#` in one of the `use` statements
Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK 57c2f39

Interesting. Does this actually have any effect? Was the old code rendering a floating Txid, Witnss without even a use bitcoin::?

@storopoli
Copy link
Contributor Author

Yes it was rendering a floating Txid, Witness, but that did not impact tests, since we remove all the hide comments # before running the tests.

@storopoli
Copy link
Contributor Author

This is explained here:

### Testing the code snippets
Since [`mdbook` does not support external crates](https://github.com/rust-lang/mdBook/issues/706),
we use [a solution provided by `doc-comment`](https://github.com/rust-lang/mdBook/issues/706#issuecomment-1139423009)
to test the code snippets in the cookbook.
First, go to the `tests/` directory:
```bash
cd tests
```
Then, run the `generate.sh` to automatically generate all tests files:
```bash
./generate.sh
```
Finally run the tests:
```bash
cargo test
```

Copy link
Member

@tcharding tcharding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 57c2f39

@tcharding tcharding merged commit adda3c3 into rust-bitcoin:master May 1, 2024
@storopoli storopoli deleted the patch-1 branch May 1, 2024 21:37
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.

3 participants