Commit 900d508
committed
Merge #129: doc: fix
6eece87 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 6eece87
Tree-SHA512: fafe24422f41c0360f2138af0ea133c98bf88fcd5b4012a1cf336af51cfb309cfc3f867ce3c061e03519560ac2e90fe20d3b50accaf1bbbfafdfd966c12f1e21cargo doc builds when non-default features selected1 file changed
+5
-2
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
63 | 63 | | |
64 | 64 | | |
65 | 65 | | |
66 | | - | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
67 | 70 | | |
68 | 71 | | |
69 | 72 | | |
| |||
87 | 90 | | |
88 | 91 | | |
89 | 92 | | |
90 | | - | |
| 93 | + | |
91 | 94 | | |
92 | 95 | | |
93 | 96 | | |
| |||
0 commit comments