api-guidelines
api-guidelines copied to clipboard
rust-lang
Rust API guidelines
[C-CONV](https://rust-lang-nursery.github.io/api-guidelines/naming.html#ad-hoc-conversions-follow-as_-to_-into_-conventions-c-conv) and [C-CONV-TRAITS](https://rust-lang-nursery.github.io/api-guidelines/interoperability.html#conversions-use-the-standard-traits-from-asref-asmut-c-conv-traits) do not mention each other as possibilities, while both are very closely related (in providing conversions), and as an API designer you might want to choose between...
While practically all other guidelines are very pleasant to read and extremely useful, C-CRATE-DOC is an empty placeholder that leads down a confusing rabbit hole. If you click it you...
Along with a summary of the discussion and perspectives so far for each.
First let me say that `C-STRUCT-BOUNDS` talks about derived bounds mainly, which is completely fine, just a bit confusing (as the text down below speaks about bounds in general). I'd...
the last post to [gitter channel](https://gitter.im/rust-impl-period/WG-libs-guidelines) is from 2017. Most of the content referenced in these guidelines seems to originate with [Rust RFCs](https://github.com/rust-lang/rfcs) which references * [official Discord server](https://discord.gg/rust-lang) *...
For example clicking on the "Macro syntax is evocative of the output" currently links to https://rust-lang-nursery.github.io/api-guidelines/macros.html#input-syntax-is-evocative-of-the-output-c-evocative. Instead it should link to https://rust-lang-nursery.github.io/api-guidelines/macros.html#c-evocative as the checklist does. This would allow us...
There's no need to have a doc-hidden method to simulate private trait items. They can be placed in the supertrait that performs the sealing. The advantage here is that the...
[C-COMMON-TRAITS](https://rust-lang.github.io/api-guidelines/interoperability.html#c-common-traits) says that _"crates that define new types should eagerly implement all applicable, common traits."_ The problem with this comes with the vague definition of _applicable_, which may indicate that...
[C-STABLE](https://rust-lang.github.io/api-guidelines/necessities.html#public-dependencies-of-a-stable-crate-are-stable-c-stable) says: > A crate cannot be stable (>=1.0.0) without all of its public dependencies being stable. However, [Cargo treats unstable versions in a special way](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-cratesio): > The version 0.0.x...
