From a41d101cf522d52a038cf51ee876db208298efa6 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Thu, 15 Feb 2024 10:21:34 -0500 Subject: [PATCH] some schema description fixes --- doc/world_builder_declarations.schema.json | 18 +++++++++--------- doc/world_builder_declarations_closed.md | 18 +++++++++--------- doc/world_builder_declarations_open.md | 18 +++++++++--------- .../coordinate_systems/cartesian.cc | 6 +++--- .../coordinate_systems/interface.cc | 2 +- source/world_builder/features/interface.cc | 2 +- .../world_builder/gravity_model/interface.cc | 2 +- 7 files changed, 33 insertions(+), 33 deletions(-) diff --git a/doc/world_builder_declarations.schema.json b/doc/world_builder_declarations.schema.json index b15d9ec73..f2eee7ad5 100644 --- a/doc/world_builder_declarations.schema.json +++ b/doc/world_builder_declarations.schema.json @@ -80,7 +80,7 @@ "oneOf": [ { "type": "object", - "description": "A Cartesian coordinate system. Coordinates are (x,y,z) and extend infintly in all directions.", + "description": "A Cartesian coordinate system. Coordinates are (x,y,z) and extend infinitely in all directions.", "additionalProperties": false, "required": [ "model" @@ -89,7 +89,7 @@ "model": { "default value": "", "type": "string", - "description": "The name which the user has given to the feature.", + "description": "The name of the coordinate system to use.", "enum": [ "cartesian" ] @@ -108,7 +108,7 @@ "model": { "default value": "", "type": "string", - "description": "The name which the user has given to the feature.", + "description": "The name of the coordinate system to use.", "enum": [ "spherical" ] @@ -149,7 +149,7 @@ "model": { "default value": "", "type": "string", - "description": "The name which the user has given to the feature.", + "description": "The name of the model for the gravity to use.", "enum": [ "uniform" ] @@ -180,7 +180,7 @@ "model": { "default value": "", "type": "string", - "description": "The name which the user has given to the feature.", + "description": "The model name of the feature determining its type.", "enum": [ "continental plate" ] @@ -1211,7 +1211,7 @@ "model": { "default value": "", "type": "string", - "description": "The name which the user has given to the feature.", + "description": "The model name of the feature determining its type.", "enum": [ "fault" ] @@ -3372,7 +3372,7 @@ "model": { "default value": "", "type": "string", - "description": "The name which the user has given to the feature.", + "description": "The model name of the feature determining its type.", "enum": [ "mantle layer" ] @@ -4402,7 +4402,7 @@ "model": { "default value": "", "type": "string", - "description": "The name which the user has given to the feature.", + "description": "The model name of the feature determining its type.", "enum": [ "oceanic plate" ] @@ -5882,7 +5882,7 @@ "model": { "default value": "", "type": "string", - "description": "The name which the user has given to the feature.", + "description": "The model name of the feature determining its type.", "enum": [ "subducting plate" ] diff --git a/doc/world_builder_declarations_closed.md b/doc/world_builder_declarations_closed.md index 39e7553c9..100d7f7e7 100644 --- a/doc/world_builder_declarations_closed.md +++ b/doc/world_builder_declarations_closed.md @@ -125,7 +125,7 @@ :name: closed_coordinate-system_oneOf_1 - **type**:object -- **description**:A Cartesian coordinate system. Coordinates are (x,y,z) and extend infintly in all directions. +- **description**:A Cartesian coordinate system. Coordinates are (x,y,z) and extend infinitely in all directions. - **additionalProperties**:false - **required**:[model] @@ -134,7 +134,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The name of the coordinate system to use. - **enum**:[cartesian] ::::::::::::::::::::: @@ -155,7 +155,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The name of the coordinate system to use. - **enum**:[spherical] ::::::::::::::::::::: @@ -205,7 +205,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The name of the model for the gravity to use. - **enum**:[uniform] ::::::::::::::::::::: @@ -249,7 +249,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The model name of the feature determining its type. - **enum**:[continental plate] :::::::::::::::::::: @@ -1846,7 +1846,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The model name of the feature determining its type. - **enum**:[fault] :::::::::::::::::::: @@ -4807,7 +4807,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The model name of the feature determining its type. - **enum**:[mantle layer] :::::::::::::::::::: @@ -6404,7 +6404,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The model name of the feature determining its type. - **enum**:[oceanic plate] :::::::::::::::::::: @@ -8689,7 +8689,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The model name of the feature determining its type. - **enum**:[subducting plate] :::::::::::::::::::: diff --git a/doc/world_builder_declarations_open.md b/doc/world_builder_declarations_open.md index 2c209a715..3ca56f5af 100644 --- a/doc/world_builder_declarations_open.md +++ b/doc/world_builder_declarations_open.md @@ -141,7 +141,7 @@ :name: open_coordinate-system_oneOf_1 - **type**:object -- **description**:A Cartesian coordinate system. Coordinates are (x,y,z) and extend infintly in all directions. +- **description**:A Cartesian coordinate system. Coordinates are (x,y,z) and extend infinitely in all directions. - **additionalProperties**:false - **required**:[model] @@ -151,7 +151,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The name of the coordinate system to use. - **enum**:[cartesian] ::::::::::::::::::::: @@ -174,7 +174,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The name of the coordinate system to use. - **enum**:[spherical] ::::::::::::::::::::: @@ -230,7 +230,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The name of the model for the gravity to use. - **enum**:[uniform] ::::::::::::::::::::: @@ -280,7 +280,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The model name of the feature determining its type. - **enum**:[continental plate] :::::::::::::::::::: @@ -2092,7 +2092,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The model name of the feature determining its type. - **enum**:[fault] :::::::::::::::::::: @@ -5397,7 +5397,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The model name of the feature determining its type. - **enum**:[mantle layer] :::::::::::::::::::: @@ -7209,7 +7209,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The model name of the feature determining its type. - **enum**:[oceanic plate] :::::::::::::::::::: @@ -9801,7 +9801,7 @@ - **default value**: - **type**:string -- **description**:The name which the user has given to the feature. +- **description**:The model name of the feature determining its type. - **enum**:[subducting plate] :::::::::::::::::::: diff --git a/source/world_builder/coordinate_systems/cartesian.cc b/source/world_builder/coordinate_systems/cartesian.cc index 83ee16ae4..cc8f3a47a 100644 --- a/source/world_builder/coordinate_systems/cartesian.cc +++ b/source/world_builder/coordinate_systems/cartesian.cc @@ -37,7 +37,7 @@ namespace WorldBuilder Cartesian::declare_entries(Parameters &prm, const std::string & /*unused*/) { prm.declare_entry("", Types::Object(), - "A Cartesian coordinate system. Coordinates are (x,y,z) and extend infintly in all directions."); + "A Cartesian coordinate system. Coordinates are (x,y,z) and extend infinitely in all directions."); } void @@ -77,9 +77,9 @@ namespace WorldBuilder Cartesian::distance_between_points_at_same_depth(const Point<3> &point_1, const Point<3> &point_2) const { WBAssert(point_1.get_coordinate_system() == cartesian, - "Can not convert non cartesian points through the cartesian coordinate system."); + "Can not convert non-Cartesian points through the Cartesian coordinate system."); WBAssert(point_2.get_coordinate_system() == cartesian, - "Can not convert non cartesian points through the cartesian coordinate system."); + "Can not convert non-Cartesian points through the Cartesian coordinate system."); // Todo: check that points are at the same depth. const Point<3> difference = point_1-point_2; const Point<2> point_at_depth(difference[0],difference[1], cartesian); diff --git a/source/world_builder/coordinate_systems/interface.cc b/source/world_builder/coordinate_systems/interface.cc index 012d94762..8dbb264c8 100644 --- a/source/world_builder/coordinate_systems/interface.cc +++ b/source/world_builder/coordinate_systems/interface.cc @@ -51,7 +51,7 @@ namespace WorldBuilder prm.declare_entry("", Types::Object(required_entries), "Coordinate system object"); prm.declare_entry("model",Types::String("",iter.first), - "The name which the user has given to the feature."); + "The name of the coordinate system to use."); iter.second(prm, parent_name); } diff --git a/source/world_builder/features/interface.cc b/source/world_builder/features/interface.cc index b5a37672d..90eea9aa8 100644 --- a/source/world_builder/features/interface.cc +++ b/source/world_builder/features/interface.cc @@ -80,7 +80,7 @@ namespace WorldBuilder prm.declare_entry("", Types::Object(required_entries), "feature object"); prm.declare_entry("model", Types::String("",it.first), - "The name which the user has given to the feature."); + "The model name of the feature determining its type."); prm.declare_entry("name", Types::String(""), "The name which the user has given to the feature."); prm.declare_entry("coordinates", Types::Array(Types::Point<2>(), 1), diff --git a/source/world_builder/gravity_model/interface.cc b/source/world_builder/gravity_model/interface.cc index d9041c5d2..19b6b1eef 100644 --- a/source/world_builder/gravity_model/interface.cc +++ b/source/world_builder/gravity_model/interface.cc @@ -50,7 +50,7 @@ namespace WorldBuilder prm.declare_entry("", Types::Object(required_entries), "gravity model"); prm.declare_entry("model",Types::String("",it.first), - "The name which the user has given to the feature."); + "The name of the model for the gravity to use."); it.second(prm, parent_name); }