string
string copied to clipboard
cargo doc chokes on this crate
I'm running up to date nightly.
error: `[Bytes]` cannot be resolved, ignoring it... ] 102/382: unicode-normalization, indexmap(doc), indexmap, string(doc), linked-hash-map(doc), futures-...
--> /home/user/.cargo/registry/src/github.com-1ecc6299db9ec823/string-0.1.0/src/lib.rs:26:27
|
26 | /// party types, such as [`Bytes`].
| ^^^^^^^ cannot be resolved, ignoring
|
note: lint level defined here
--> /home/user/.cargo/registry/src/github.com-1ecc6299db9ec823/string-0.1.0/src/lib.rs:17:9
|
17 | #![deny(warnings, missing_docs, missing_debug_implementations)]
| ^^^^^^^^
= note: #[deny(intra_doc_link_resolution_failure)] implied by #[deny(warnings)]
= help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`
error: Could not document `string`.
Same issue. Asked on IRC and they didn't have any ideas. 2018-06-20 didn't work either, but 2018-06-01 did.
Seems fixed by #2.
The problem would be completely solved after #3 is merged and released, but for a while, we can use patch feature for Cargo.toml:
[patch.crates-io]
string = { git = "https://github.com/carllerche/string.git", rev = "fc97eabe02282c260aaa9b6e5cb69fab52985d4b" }
(IMHO, deny(warnings) (maybe almost same as -Werror in C++) should not be specified for libraries to be released, because it may accidentally fails to compile when compiler implementation (not language itself) changes...)
This looks like it can be closed.