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

nighlty rustdoc issues warning for code using Error #51871

Closed
tspiteri opened this issue Jun 28, 2018 · 4 comments
Closed

nighlty rustdoc issues warning for code using Error #51871

tspiteri opened this issue Jun 28, 2018 · 4 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@tspiteri
Copy link
Contributor

For this lib.rs:

pub struct Foo(std::error::Error);

I get this:

$ rustdoc +nightly -V
rustdoc 1.28.0-nightly (cd494c1f0 2018-06-27)
$ rustdoc +nightly lib.rs 
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 `\]`
@GuillaumeGomez
Copy link
Member

Oh funny. They try to document the inner element as well.

@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jun 28, 2018
@MajorBreakfast
Copy link
Contributor

MajorBreakfast commented Jul 7, 2018

@tspiteri Can you try out if this still happens? This seems familiar. I think I fixed this a few days ago. Now that we have a new nightly it might work.

PR #51853

@tspiteri
Copy link
Contributor Author

tspiteri commented Jul 7, 2018

@MajorBreakfast Yes, it is fixed with the new nightly.

@MajorBreakfast
Copy link
Contributor

@tspiteri Perfect :)

I think this issue can be closed

@tspiteri tspiteri closed this as completed Jul 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants