Commit 7574b269 authored by Wohlgemuth, Jason's avatar Wohlgemuth, Jason
Browse files

fix(docs): Use correct punctuation for eg

parent a59db02e

acorn-lib/src/schema/mod.rs

+6 −6
Original line number Diff line number Diff line
@@ -217,14 +217,14 @@ pub enum TechnologyReadinessLevel { 
#[builder(start_fn = init)]

#[serde(deny_unknown_fields, rename_all = "camelCase")]

pub struct ContactPoint {

    /// Job title (e.g. "Group Lead") of role that the contact fills related to the asscociated research activity.

    /// Job title (e.g., "Group Lead") of role that the contact fills related to the asscociated research activity.

    /// ### Example

    /// > Ideal contact title for a project would be "Primary Investigator"

    ///

    /// ### Example

    /// > Ideal contact title for a group organization would be "Group Lead"

    ///

    /// <div class="warning">When the nearest associated title is unclear, job role of the contact can be used (e.g. "Senior Scientist").</div>

    /// <div class="warning">When the nearest associated title is unclear, job role of the contact can be used (e.g., "Senior Scientist").</div>

    ///

    /// See <https://schema.org/jobTitle> for more information

    #[builder(default = "Researcher".to_string())]
@@ -276,7 +276,7 @@ pub struct ContactPoint { 
    /// See <https://schema.org/affiliation> for more information

    pub affiliation: Option<String>,

}

/// Image format media (e.g. PNG, JPEG, SVG, etc.)

/// Image format media (e.g., PNG, JPEG, SVG, etc.)

///

/// See <https://schema.org/ImageObject>

#[skip_serializing_none]
@@ -377,7 +377,7 @@ pub struct Metadata { 
    /// See [Keyword]

    #[builder(default = Vec::<String>::new())]

    pub keywords: Vec<Keyword>,

    /// Software, programmings languages, and digital resources (e.g. tools, libraries, frameworks, data) related to the associated research activity data

    /// Software, programmings languages, and digital resources (e.g., tools, libraries, frameworks, data) related to the associated research activity data

    /// ### Examples

    /// - Rust

    /// - Polars
@@ -442,7 +442,7 @@ pub struct Organization { 
    /// See <https://www.ror.org/> for more information

    #[serde(default, deserialize_with = "option_string_trim")]

    pub ror: Option<String>,

    /// Organization alias (e.g. acronym or nickname)

    /// Organization alias (e.g., acronym or nickname)

    ///

    /// See <https://schema.org/alternateName> for more information

    #[serde(default, deserialize_with = "option_string_trim")]
@@ -492,7 +492,7 @@ pub struct ResearchActivity { 
    /// Other information related to the associated research activity not easily captured in structured areas of the schema

    pub notes: Option<Other>,

}

/// Video format media (e.g. MP4, AVI, MOV, GIF, etc.)

/// Video format media (e.g., MP4, AVI, MOV, GIF, etc.)

///

/// See <https://schema.org/VideoObject> for more information

#[skip_serializing_none]

acorn-lib/src/schema/raid.rs

+8 −9
Original line number Diff line number Diff line
@@ -97,7 +97,7 @@ pub enum DescriptionType { 
    /// Other (i.e., any other descriptive information such as a note)

    Other,

}

/// Flag indicating that a value is affirmative (e.g. for `leader` or `contact`)

/// Flag indicating that a value is affirmative (e.g., for `leader` or `contact`)

#[derive(Clone, Debug, Deserialize, JsonSchema, Serialize)]

pub enum Flag {

    /// Affirmative flag
@@ -237,8 +237,7 @@ pub enum OrganizationRoleType { 
}

/// Represents a contributor's administrative position on a project (such as their position on a grant application)

/// 

/// *Note*

/// > Use [`Contributor`]'s [`Role`] to define scientific or scholarly contributions

/// <div class="warning">Use contributor role to define scientific or scholarly contributions</div>

#[derive(Clone, Debug, Deserialize, Display, JsonSchema, Serialize)]

#[serde(rename = "kebab-case")]

pub enum PositionType {
@@ -313,7 +312,7 @@ pub struct Access { 
    pub access_type: AccessIdentifier,

    /// Date an embargo on access to the RAiD metadata ends

    /// ### Format

    /// > [ISO 8601] standard date (e.g. `YYYY-MM-DD`)

    /// > [ISO 8601] standard date (e.g., `YYYY-MM-DD`)

    ///

    /// <div class="warning">Mandatory if access type is "embargoed"</div>

    ///
@@ -428,13 +427,13 @@ pub struct ContributorPosition { 
pub struct Date {

    /// Associated data start date

    /// ### Format

    /// > [ISO 8601] standard date (e.g. `YYYY-MM-DD`)

    /// > [ISO 8601] standard date (e.g., `YYYY-MM-DD`)

    ///

    /// [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601

    pub start_date: String,

    /// Associated data end date

    /// ### Format

    /// > [ISO 8601] standard date (e.g. `YYYY-MM-DD`)

    /// > [ISO 8601] standard date (e.g., `YYYY-MM-DD`)

    ///

    /// [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601

    pub end_date: Option<String>,
@@ -747,13 +746,13 @@ pub struct Title { 
    pub language: Option<Language>,

    /// Date the project or activity's title began being used

    /// ### Format

    /// > [ISO 8601] standard date (e.g. `YYYY-MM-DD`)

    /// > [ISO 8601] standard date (e.g., `YYYY-MM-DD`)

    ///

    /// [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601

    pub start_date: String,

    /// Date the project or activity title was changed or stopped being used

    /// ### Format

    /// > [ISO 8601] standard date (e.g. `YYYY-MM-DD`)

    /// > [ISO 8601] standard date (e.g., `YYYY-MM-DD`)

    ///

    /// <div class="warning">Only the year is required, month and day are optional</div>

    ///