Skip to content

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

Closed
@ErichDonGubler

Description

@ErichDonGubler

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)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions