Add note on SpecOptionPartialEq to newtype_index

This commit is contained in:
clubby789 2024-01-14 00:24:39 +00:00
parent d78329b92e
commit 4ca6342eb3
2 changed files with 4 additions and 0 deletions

View File

@ -31,6 +31,9 @@
/// - `#[max = 0xFFFF_FFFD]`: specifies the max value, which allows niche
/// optimizations. The default max value is 0xFFFF_FF00.
/// - `#[gate_rustc_only]`: makes parts of the generated code nightly-only.
///
/// `SpecOptionPartialEq` is specialized by this macro, so using it requires enabling
/// `#![feature(min_specialization)]` for the crate.
#[proc_macro]
#[cfg_attr(
feature = "nightly",

View File

@ -2147,6 +2147,7 @@ fn eq(&self, other: &Self) -> bool {
///
/// Once that's fixed, `Option` should go back to deriving `PartialEq`, as
/// it used to do before <https://github.com/rust-lang/rust/pull/103556>.
/// The comment regarding this trait on the `newtype_index` macro should be removed if this is done.
#[unstable(feature = "spec_option_partial_eq", issue = "none", reason = "exposed only for rustc")]
#[doc(hidden)]
pub trait SpecOptionPartialEq: Sized {