GREsau/schemars

Toggle ability to ignore Example code in documentation

EdmundsEcho opened this issue · 0 comments

The example code included in the documentation gets included in the schema. It may be useful to toggle the ability to ignore this part of the documentation.

/// Include this information
///
/// # Example
///
/// ```
/// use serde::{Deserialize, Serialize};
/// use tnc_analysis_lib::prelude::Cfg;
///
/// let json = r#"{
///     "match-criteria": {
///        ...
///      }
///   }"#;
/// let model: Cfg = serde_json::from_str(&json).unwrap();
/// assert!(model.quality_fields.len() == 0);
/// ```
#[derive(Clone, Debug, Deserialize, JsonSchema)]
pub struct Cfg {
    ...
}