api-guidelines

A change I find interesting in this release is the addition of `Deref`/`DerefMut` derives[0]. It addresses a very real pain point in bevy, due to `#[derive(Component)]`'s interaction with the orphan rules requiring newtypes[^1]. But it's potentially not idiomatic within the Rust language, at least at the moment (as mentioned in the OP). However, I think that the tide is likely to turn on that; for example, in the api-guidelines repo, there's a PR[2] to remove this advice. This appears to have stalled, although that appears to be not for reasons of it being controversial, just lack of reviews; the discussion had broad support. We have discussed (in Discord[3]) a kind of 'internal' `Deref`, which would use lenses to do automatic unwrapping for queries. See #4413 [4] for an example of what this would look like. I'm not sure how necessary tha

About the guidelines, from https://rust-lang.github.io/api-guidelines/about.html > This is a set of recommendations on how to design and present APIs for the Rust programming language. They are authored largely by the Rust library team, based on experiences building the Rust standard library and other crates in the Rust ecosystem. GitHub repo for the guidelines: https://github.com/rust-lang/api-guidelines I am submitting the OP link to HN because I believe that these guidelines are useful to many people that have, or wish to, publish Rust crates that other people will then use. Following these guidelines will make the crates we make feel "native to Rust" for other people that want to make use of our crates. I found these guidelines just a couple of days ago for the first time, in spite of having written Rust for several years now. And I s

Clippy has some checks for naming convention beyond what rustc and rustfmt does. Not nearly as much as https://github.com/brson/rust-api-guidelines, but the wrong_self_convention check helped me make sense of the as/to/into conventions. https://github.com/Manishearth/rust-clippy

It's part of the checklist: https://github.com/brson/rust-api-guidelines#interoperabilit... Maybe the checklist should get a more prominent link or notice in the blog post. It took me a while to find it.