Struct ConventionNote 

pub struct ConventionNote {
    pub slug: &'static str,
    pub aspect: &'static str,
    pub convention: &'static str,
    pub differs_from: &'static str,
    pub source: &'static str,
    pub guidance: &'static str,
}

One convention that a caller could plausibly get wrong.

Fields

slug: &'static str

Indicator slug this note applies to (matches metadata_registry).

aspect: &'static str

What aspect of the calculation is ambiguous, e.g. “smoothing”, “scaling”.

convention: &'static str

The convention this implementation actually follows.

differs_from: &'static str

Widely used conventions this implementation does not follow.

source: &'static str

Recorded provenance for the implemented convention, or an explicit statement that no source has been established.

guidance: &'static str

What a caller should do about it.

Trait Implementations

impl Clone for ConventionNote

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ConventionNote

impl Debug for ConventionNote

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ConventionNote

impl PartialEq for ConventionNote

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ConventionNote

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConventionNote