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

Suppress missing docs warning #49

Merged
merged 1 commit into from
Feb 12, 2022

Conversation

billy1624
Copy link
Contributor

Hi, there. This PR aims to suppress missing docs warning of Rust linter while using #[ouroboros::self_referencing] with #![warn(missing_docs)] enabled.

E.g. https://github.com/SeaQL/sea-orm/runs/4076651605

missing documentation for a struct
warning: missing documentation for a struct
  --> src/database/stream/transaction.rs:14:1
   |
14 | #[ouroboros::self_referencing]
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: this warning originates in the attribute macro `ouroboros::self_referencing` (in Nightly builds, run with -Z macro-backtrace for more info)

Thanks!!

@billy1624
Copy link
Contributor Author

Ping @joshua-maros

@someguynamedjosh someguynamedjosh merged commit 63fc451 into someguynamedjosh:main Feb 12, 2022
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 this pull request may close these issues.

None yet

2 participants