Skip to content

docs: fix link to VecDeque#108

Merged
jdonszelmann merged 1 commit into
NULLx76:mainfrom
tertsdiepraam:fix-doc-link-to-vecdeque
Jun 8, 2023
Merged

docs: fix link to VecDeque#108
jdonszelmann merged 1 commit into
NULLx76:mainfrom
tertsdiepraam:fix-doc-link-to-vecdeque

Conversation

@tertsdiepraam

@tertsdiepraam tertsdiepraam commented Jun 8, 2023

Copy link
Copy Markdown
Contributor

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
Copy Markdown
Collaborator

Thanks!

NULLx76 pushed a commit that referenced this pull request Jul 11, 2025
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