Xudong-Huang / generator-rs

rust stackful generator library
Apache License 2.0
286 stars 35 forks source link

fix doc comment placement #10

Closed euclio closed 5 years ago

euclio commented 5 years ago

rust-lang/rust#57882 is modifying the unused_doc_comments lint to fire on mistakenly documented macro expansions. A crater run detected that this crate will break due to this change, likely because of the use of deny(unused_doc_comments) or deny(warnings).

While this kind of breakage is allowed under Rust's stability guarantees, I am opening PRs to affected crates to reduce the impact.

This PR protects your crate from future breakage by moving the doc comment inside the macro invocation.

Xudong-Huang commented 5 years ago

thanks!