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

missing_docs warning in easy_wrapper implementation #61

Closed
notgull opened this issue May 28, 2023 · 2 comments · Fixed by #66
Closed

missing_docs warning in easy_wrapper implementation #61

notgull opened this issue May 28, 2023 · 2 comments · Fixed by #66

Comments

@notgull
Copy link
Member

notgull commented May 28, 2023

warning: missing documentation for a method
    --> src/lib.rs:1102:1
     |
1102 | / easy_wrapper! {
1103 | |     /// A future returned by [`Receiver::recv()`].
1104 | |     #[derive(Debug)]
1105 | |     #[must_use = "futures do nothing unless you `.await` or poll them"]
1106 | |     pub struct Recv<'a, T>(RecvInner<'a, T> => Result<T, RecvError>);
1107 | |     pub(crate) wait();
1108 | | }
     | |_^
     |
     = note: this warning originates in the macro `$crate::__pin_project_struct_make_proj_method` which comes from the expansion of the macro `easy_wrapper` (in Nightly builds, run with -Z macro-backtrace for more info)

It looks like this comes from pin_project_lite, but I'm not sure from where, exactly. Since this issue hasn't been observed in other crates that use pin_project_lite I don't think it's an issue with that crate.

@notgull
Copy link
Member Author

notgull commented May 28, 2023

This is currently blocking #58.

@taiki-e
Copy link
Collaborator

taiki-e commented May 29, 2023

I thought it may be related to rust-lang/rust#77973, but it is not clear what is happening.

Could you extract the code that is having problems and run the cargo-expand against that code?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

2 participants