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

cargo doc breaks for 2018-06-18 nightly #437

Closed
ErichDonGubler opened this issue Jun 20, 2018 · 13 comments · Fixed by #816
Closed

cargo doc breaks for 2018-06-18 nightly #437

ErichDonGubler opened this issue Jun 20, 2018 · 13 comments · Fixed by #816
Assignees

Comments

@ErichDonGubler
Copy link

ErichDonGubler commented Jun 20, 2018

The crux of the issue seems to be lib.rs:9, where [notified] doesn't actually refer to anything in source.

I've included a sample invocation below, but if you need any further information please let me know! Builds for uploads-im-client-rs are breaking because I decided to include a cargo doc --verbose command. I would love to keep my CI more rigorous, but I can't with this issue!

Log output
~/…/tokio/tokio-executor master$ cargo +nightly-2018-06-18 doc
 Documenting futures v0.1.21
    Checking futures v0.1.21
warning: `[Debug]` cannot be resolved, ignoring it...
   |
   = note: #[warn(intra_doc_link_resolution_failure)] on by default
   = note: the link appears in this line:

            themselves through the [`Display`] and [`Debug`] traits, and may provide
                                                    ^^^^^^^
   = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

 Documenting tokio-executor v0.1.2 (file:///C:/Users/egubler/workspace/personal/bug-reports/tokio/tokio-executor)
error: `[notified]` cannot be resolved, ignoring it...
 --> tokio-executor\src\lib.rs:9:27
  |
9 | //! whenever the task is [notified]. Notification happens when the internal
  |                           ^^^^^^^^ cannot be resolved, ignoring
  |
note: lint level defined here
 --> tokio-executor\src\lib.rs:33:54
  |
33| #![deny(missing_docs, missing_debug_implementations, warnings)]
  |                                                      ^^^^^^^^
  = note: #[deny(intra_doc_link_resolution_failure)] implied by #[deny(warnings)]
  = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

error: Could not document `tokio-executor`.

Caused by:
  process didn't exit successfully: `rustdoc --crate-name tokio_executor tokio-executor\src\lib.rs -o C:\Users\egubler\workspace\personal\bug-reports\tokio\target\doc -L dependency=C:\Users\egubler\workspace\personal\bug-reports\tokio\target\debug\deps --extern futures=C:\Users\egubler\workspace\personal\bug-reports\tokio\target\debug\deps\libfutures-2ecc8546a5859d7a.rmeta` (exit code: 101)
@carllerche
Copy link
Member

My understanding is that cargo doc on nightly is under a lot of flux / bugs.

That said, there probably are also issues w/ the docs. I will happily accept PRs to fix broken links.

@carllerche carllerche added the E-help-wanted Call for participation: Help is requested to fix this issue. label Jun 20, 2018
@kpp
Copy link
Contributor

kpp commented Jun 25, 2018

Depends on deprecrated/net2-rs#76 | Done

@kpp
Copy link
Contributor

kpp commented Jun 25, 2018

Depends on crossbeam-rs/crossbeam-utils#21 | Released v0.4.1

@kpp
Copy link
Contributor

kpp commented Jun 25, 2018

Depends on #450 | Done

@kpp
Copy link
Contributor

kpp commented Jun 27, 2018

Depends on tokio-rs/bytes#218 | Done

@kpp
Copy link
Contributor

kpp commented Jun 28, 2018

Depends on #458 | Done

@kpp
Copy link
Contributor

kpp commented Jul 8, 2018

Depends on #471 | Done

@kpp
Copy link
Contributor

kpp commented Aug 5, 2018

Depends on rust-random/rand#584 | Released v0.5.5

@kpp
Copy link
Contributor

kpp commented Aug 6, 2018

Depends on tokio-rs/mio#861 | Released v0.6.16

@kpp
Copy link
Contributor

kpp commented Aug 6, 2018

Depends on #518 | Done

@kpp
Copy link
Contributor

kpp commented Aug 21, 2018

Depends on #556 | Done

@kpp
Copy link
Contributor

kpp commented Sep 6, 2018

Depends on #557 | Fixed

@kpp
Copy link
Contributor

kpp commented Dec 10, 2018

Depends on #792 | Done

@kpp kpp mentioned this issue Dec 10, 2018
@tobz tobz closed this as completed in #816 Dec 28, 2018
@Darksonn Darksonn removed the E-help-wanted Call for participation: Help is requested to fix this issue. label Sep 25, 2020
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 a pull request may close this issue.

5 participants