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

Fix doc warning in plan by wrapping hyperlink #129

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

SallySoul
Copy link

@SallySoul SallySoul commented Oct 10, 2024

When running cargo doc I see the following output:

 $ cargo doc
 Documenting fftw v0.8.0 (/Users/russell/projects/rust/fftw3-rs/fftw)
warning: this URL is not a hyperlink
 --> fftw/src/plan.rs:4:20
  |
4 | //! [Using Plans]: http://www.fftw.org/fftw3_doc/Using-Plans.html
  |                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  |
  = note: bare URLs are not automatically turned into clickable links
  = note: `#[warn(rustdoc::bare_urls)]` on by default
help: use an automatic link instead
  |
4 | //! [Using Plans]: <http://www.fftw.org/fftw3_doc/Using-Plans.html>
  |                    +                                              +

warning: `fftw` (lib doc) generated 1 warning (run `cargo fix --lib -p fftw` to apply 1 suggestion)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.32s
   Generated /Users/russell/projects/rust/fftw3-rs/target/doc/fftw/index.html and 2 other files

This PR just fixes this warning.

@SallySoul SallySoul changed the title Fix doc error in plan by wrapping hyperlink Fix doc warning in plan by wrapping hyperlink Oct 10, 2024
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

Successfully merging this pull request may close these issues.

1 participant