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 struct reference in documentation #109

Conversation

yanorei32
Copy link
Contributor

I tried to work with the smart handles version of this library.
But I got a warning from cargo doc.

warning: unresolved link to `File`
  --> src/filesystem/directory.rs:54:47
   |
54 |     /// Convert a raw file into a droppable [`File`]
   |                                               ^^^^ no item named `File` in scope
   |
   = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
   = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default

warning: `embedded-sdmmc` (lib doc) generated 1 warning
    Finished dev [unoptimized + debuginfo] target(s) in 0.01s

This PR fixes it.

@thejpster
Copy link
Member

Damn. We should build the docs in the github actions.

Thank you for the fix!

Co-authored-by: Jonathan 'theJPster' Pallant <[email protected]>
@thejpster thejpster enabled auto-merge December 6, 2023 08:43
@thejpster thejpster added this pull request to the merge queue Dec 6, 2023
Merged via the queue into rust-embedded-community:develop with commit 3a459d7 Dec 6, 2023
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.

2 participants