bitcoindevkit / rust-esplora-client / 15939070186

91%

push

github

Merge bitcoindevkit/rust-esplora-client#129: doc: fix `cargo doc` builds when non-default features selected

<a class=hub.com/bitcoindevkit/rust-esplora-client/commit/6eece871f422635d66a699a661e64440cc010c4b">6eece871f doc: fix cargo doc builds when non-default features selected (Philip Kannegaard Hayes)

Pull request description:

  While upgrading to `v0.12.0` our `cargo doc` builds broke:

  ```bash
  $ cargo doc --no-default-features --features=async,tokio

  # ...

  error: unresolved link to `minreq`
    --> /Users/phlip9/dev/esplora-client/src/lib.rs:54:42
     |
  54 | //! * `blocking-https-bundled` enables [`minreq`], the blocking client with proxy and TLS (SSL)
     |                                          ^^^^^^ no item named `minreq` in scope
     |
     = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`

  error: public documentation for `max_retries` links to private item `RETRYABLE_ERROR_CODES`
     --> /Users/phlip9/dev/esplora-client/src/lib.rs:171:21
      |
  171 |     /// is one of [`RETRYABLE_ERROR_CODES`].
      |                     ^^^^^^^^^^^^^^^^^^^^^ this item is private

  # ... etc
  ```

  To keep the nice doc links to `minreq` and `reqwest`, I just pointed them to <https://docs.rs/minreq> and <https://docs.rs/reqwest> respectively. It won't resolve to the exact version, but it's better than nothing IMO.

ACKs for top commit:
  notmandatory:
    ACK 6eece871f422635d66a699a661e64440cc010c4b

Tree-SHA512: fafe244225b4012a1c3519560acc12f1e21

1052 of 1201 relevant lines covered (87.59%)

7.76 hits per line