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 is failing #1497

Closed
oysterpack opened this issue Mar 25, 2019 · 2 comments
Closed

cargo doc is failing #1497

oysterpack opened this issue Mar 25, 2019 · 2 comments

Comments

@oysterpack
Copy link

running cargo +nightly doc on a project that includes futures-preview fails with the below error:

...
error: `[Box::pinned]` cannot be resolved, ignoring it...
   --> /home/alfio/.cargo/registry/src/github.aaakk.us.kg-1ecc6299db9ec823/futures-util-preview-0.3.0-alpha.13/src/try_stream/mod.rs:602:84
    |
602 |     /// first have to pin the stream. This can be done by boxing the stream using [`Box::pinned`]
    |                                                                                    ^^^^^^^^^^^^^ cannot be resolved, ignoring
    |
    = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

error: aborting due to 147 previous errors

Caused by:
  process didn't exit successfully: `rustdoc --edition=2018 --crate-name ruggine_concurrency ruggine-concurrency/src/lib.rs  ...

Meta

  • rustdoc 1.35.0-nightly (94fd04589 2019-03-21)
@taiki-e
Copy link
Member

taiki-e commented Mar 25, 2019

The old method name will fix in #1498, but the errors is a problem of rustdoc (see rust-lang/rust#43466 (comment) and rust-lang/rust#56922).

Also, if that project uses #![deny(warnings)] or RUSTDOCFLAGS=-Dwarnings, you may be able to avoid the error by changing it (e.g., use #![cfg_attr(test, deny(warnings))], remove it, etc). (intra_doc_link_resolution_failure is a warning by default).

@oysterpack
Copy link
Author

Thanks - the project uses #![deny(warnings)] and removing it resolved the issue ... now I can generate docs for the project excluding dependencies

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

No branches or pull requests

2 participants