Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Check for rustdoc warnings #340

Open
Techcable opened this issue Sep 23, 2024 · 0 comments
Open

ci: Check for rustdoc warnings #340

Techcable opened this issue Sep 23, 2024 · 0 comments

Comments

@Techcable
Copy link
Member

Techcable commented Sep 23, 2024

Right now, there are two rustdoc warnings that CI hasn't caught.

   Compiling slog v2.8.0-beta.2 (/Users/nicholas/git/slog.org/slog)
 Documenting slog v2.8.0-beta.2 (/Users/nicholas/git/slog.org/slog)
warning: this URL is not a hyperlink
    --> src/lib.rs:1332:30
     |
1332 |     /// default to `()` once https://github.com/rust-lang/rust/issues/29661 is
     |                              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     |
     = note: bare URLs are not automatically turned into clickable links
     = note: `#[warn(rustdoc::bare_urls)]` on by default
help: use an automatic link instead
     |
1332 |     /// default to `()` once <https://github.com/rust-lang/rust/issues/29661> is
     |                              +                                              +

warning: this URL is not a hyperlink
    --> src/lib.rs:1796:16
     |
1796 | /// Reference: https://github.com/rust-lang/rust/issues/34511
     |                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     |
     = note: bare URLs are not automatically turned into clickable links
help: use an automatic link instead
     |
1796 | /// Reference: <https://github.com/rust-lang/rust/issues/34511>
     |                +                                              +

warning: `slog` (lib doc) generated 2 warnings (run `cargo fix --lib -p slog` to apply 2 suggestions)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.84s
     Opening /Users/nicholas/git/slog.org/slog/target/doc/slog/index.html

It would be good to catch these automatically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant