search

eyre-rs / eyre

A trait object based error handling type for easy idiomatic error handling and reporting in Rust applications
Apache License 2.0
1.35k stars 63 forks source link

`cargo doc` warning: "this URL is not a hyperlink" #137

Closed LeoniePhiline closed 8 months ago

LeoniePhiline commented 8 months ago

cargo doc raises two "bare URL" warnings:

warning: this URL is not a hyperlink
   --> eyre/src/lib.rs:241:5
    |
241 | //! https://github.com/eyre-rs/eyre/pull/29/commits/608a16aa2c2c27eca6c88001cc94c6973c18f1d5
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://github.com/eyre-rs/eyre/pull/29/commits/608a16aa2c2c27eca6c88001cc94c6973c18f1d5>`
    |
    = note: bare URLs are not automatically turned into clickable links
    = note: `#[warn(rustdoc::bare_urls)]` on by default

warning: this URL is not a hyperlink
   --> eyre/src/lib.rs:317:47
    |
317 | //! [^1]: example and explanation of breakage https://github.com/eyre-rs/eyre/issues/30#issuecomment-647650361
    |                                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: use an automatic link instead: `<https://github.com/eyre-rs/eyre/issues/30#issuecomment-647650361>`
    |
    = note: bare URLs are not automatically turned into clickable links

warning: `eyre` (lib doc) generated 2 warnings (run `cargo fix --lib -p eyre` to apply 2 suggestions)