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

riscv-semihosting: fix ambiguous documentation link #224

Merged
merged 1 commit into from
Aug 13, 2024

Conversation

00xc
Copy link
Contributor

@00xc 00xc commented Jul 30, 2024

Fix the following warning when generating the crate documentation:

warning: `syscall` is both a function and a macro
   --> riscv-semihosting/src/lib.rs:212:15
    |
212 | /// Same as [`syscall`].
    |               ^^^^^^^ ambiguous link
    |
    = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
help: to link to the function, add parentheses
    |
212 | /// Same as [`syscall()`].
    |                      ++
help: to link to the macro, add an exclamation mark
    |
212 | /// Same as [`syscall!`].
    |                      +

Fix the following warning when generating the crate documentation:

warning: `syscall` is both a function and a macro
   --> riscv-semihosting/src/lib.rs:212:15
    |
212 | /// Same as [`syscall`].
    |               ^^^^^^^ ambiguous link
    |
    = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
help: to link to the function, add parentheses
    |
212 | /// Same as [`syscall()`].
    |                      ++
help: to link to the macro, add an exclamation mark
    |
212 | /// Same as [`syscall!`].
    |                      +
@romancardenas romancardenas added this pull request to the merge queue Aug 13, 2024
Merged via the queue into rust-embedded:master with commit 51fb773 Aug 13, 2024
95 checks passed
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.

3 participants