bitcoindevkit / bdk / 23617270750

78%

push

github

Merge bitcoindevkit/bdk#2158: ci: check-docs for all workspace packages

<a class=hub.com/bitcoindevkit/bdk/commit/9c8b564fb4d9fc0ecf6a03f1cd6668de73555eb3">9c8b564fb<a href="https://github.com/bitcoindevkit/bdk/commit/b203e31213950d8fc17cada499e5b3da2182d8c7"> fix(docs): in keychain_txout.rs and spk_client.rs (shinigami-777)
<a class="double-link" href="https://github.com/bitcoindevkit/bdk/commit/19d1269f814f445b0337d6c66cd694358afede18">19d1269f8</a> ci: add new check-docs job, justfile recipe and documentation (shinigami-777)

Pull request description:

  fixes #2152

  ### Description

  This PR adds new CI job `check-docs` to validate that documentation builds for all workspace packages, also adds a new justfile recipe `just doc`.

  It also fixes the existing errors in `bdk_chain` and `bdk_core`.

  ### Changelog notice

  ```
  ### Added

  - ci: add new `check-docs` job.

  ### Changed

  - fix(docs): in `keychain_txout.rs` and `spk_client.rs`
  ```

  ### Checklists

  #### All Submissions:

  * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md)

  #### New Features:

  * [ ] I've added tests for the new feature
  * [x] I've added docs for the new feature

  #### Bugfixes:

  * [ ] This pull request breaks the existing API
  * [ ] I've added tests to reproduce the issue which are now passing
  * [x] I'm linking the issue being fixed by this PR

ACKs for top commit:
  oleonardolima:
    ACK 9c8b564fb4d9fc0ecf6a03f1cd6668de73555eb3

Tree-SHA512: ce0726474115db09e8d73a67b0d5832d859

376 of 510 branches covered (73.73%)

Branch coverage included in aggregate %.

4293 of 5465 relevant lines covered (78.55%)

3144.86 hits per line