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

docs: fix link to VecDeque #108

Merged
merged 1 commit into from
Jun 8, 2023

Conversation

tertsdiepraam
Copy link
Contributor

@tertsdiepraam tertsdiepraam commented Jun 8, 2023

The link to std::collections::VecDeque was invalid because std was not in scope, but VecDeque was in scope via alloc so it didn't need an explicit link. This made rustdoc fail with the following error:

error: unresolved link to `std::collections::VecDeque`
 --> src/with_alloc/vecdeque.rs:8:42
  |
8 | /// Wrapper of the built-in [`VecDeque`](std::collections::VecDeque) struct
  |                                          ^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `std` in scope
  |
note: the lint level is defined here
 --> src/lib.rs:3:9
  |
3 | #![deny(warnings)]
  |         ^^^^^^^^
  = note: `#[deny(rustdoc::broken_intra_doc_links)]` implied by `#[deny(warnings)]`

error: could not document `ringbuffer`

@tertsdiepraam tertsdiepraam force-pushed the fix-doc-link-to-vecdeque branch from 758d998 to 4076629 Compare June 8, 2023 15:31
@tertsdiepraam tertsdiepraam changed the title docs: fix link to VecDeque by replacing std with alloc docs: fix link to VecDeque Jun 8, 2023
@jdonszelmann jdonszelmann merged commit d6665dd into NULLx76:main Jun 8, 2023
@jdonszelmann
Copy link
Collaborator

Thanks!

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