rust-lang / nomicon

The Dark Arts of Advanced and Unsafe Rust Programming
https://doc.rust-lang.org/nomicon/
Apache License 2.0
1.79k stars 261 forks source link

Audit the use of `ignore` annotations #283

Closed JohnTitor closed 3 years ago

JohnTitor commented 3 years ago

Currently, we use ignore annotations without comment, which makes it hard to understand why it's ignored. I saw the reference adds an explanation as a comment like <!-- expanded code -->, I like this idea. We should audit the use of ignore annotations and add comments to them on the nomicon as well.