From 5dedc5b5b7ea3b5e39543397722dd42d9760b61d Mon Sep 17 00:00:00 2001 From: Roel <75250264+RoelBollens-TomTom@users.noreply.github.com> Date: Wed, 15 Jul 2026 16:17:36 +0200 Subject: [PATCH] Chore: Fix typos in docstrings, docs, and reference example Signed-off-by: Roel <75250264+RoelBollens-TomTom@users.noreply.github.com> --- GLOSSARY.md | 2 +- SCHEMA_CONVENTIONS.md | 2 +- docs/schema/concepts/by-theme/buildings/index.mdx | 4 ++-- docs/schema/concepts/by-theme/transportation/roads.mdx | 2 +- .../concepts/by-theme/transportation/travel-modes.mdx | 4 ++-- docs/schema/concepts/scoping-rules.mdx | 5 ++--- docs/schema/reference/divisions/division.mdx | 2 +- docs/schema/reference/divisions/division_area.mdx | 4 ++-- docs/schema/reference/divisions/division_boundary.mdx | 4 ++-- .../tests/address_baseline_schema.json | 2 +- .../src/overture/schema/base/infrastructure.py | 2 +- .../src/overture/schema/base/land_use.py | 2 +- .../tests/bathymetry_baseline_schema.json | 2 +- .../tests/infrastructure_baseline_schema.json | 4 ++-- .../tests/land_baseline_schema.json | 2 +- .../tests/land_cover_baseline_schema.json | 2 +- .../tests/land_use_baseline_schema.json | 4 ++-- .../tests/water_baseline_schema.json | 2 +- .../tests/building_baseline_schema.json | 2 +- .../tests/building_part_baseline_schema.json | 2 +- .../src/overture/schema/common/models.py | 4 ++-- .../src/overture/schema/common/scoping/__init__.py | 2 +- .../src/overture/schema/common/scoping/scoped.py | 10 +++++----- .../src/overture/schema/common/scoping/travel_mode.py | 2 +- .../tests/division_area_baseline_schema.json | 2 +- .../tests/division_baseline_schema.json | 2 +- .../tests/division_boundary_baseline_schema.json | 2 +- .../tests/place_baseline_schema.json | 2 +- .../src/overture/schema/system/__init__.py | 2 +- .../src/overture/schema/system/_json_schema.py | 2 +- .../tests/connector_baseline_schema.json | 2 +- .../tests/segment_baseline_schema.json | 6 +++--- .../addresses/address_all_missing_address_levels.yaml | 2 +- schema/base/water.yaml | 2 +- 34 files changed, 48 insertions(+), 49 deletions(-) diff --git a/GLOSSARY.md b/GLOSSARY.md index 7f3604eff..5778501dd 100644 --- a/GLOSSARY.md +++ b/GLOSSARY.md @@ -14,5 +14,5 @@ A Feature Type is a type of entities with common properties as described in the Instance is a synonym for "Feature". The preferred term is "Feature". # Object -Object is a synonym for "Instance" or "Feature". The prefered term is "Feature". +Object is a synonym for "Instance" or "Feature". The preferred term is "Feature". diff --git a/SCHEMA_CONVENTIONS.md b/SCHEMA_CONVENTIONS.md index 4e5213d4e..ebf3be06d 100644 --- a/SCHEMA_CONVENTIONS.md +++ b/SCHEMA_CONVENTIONS.md @@ -45,7 +45,7 @@ Overture Features Types are strongly-typed. Feature Types are defined by three c All measurements are expressed in SI units. The exact unit is confirmed in the specification of the property but is not repeated in the data ### Regulations and restrictions - All quantities that related to posted or ordenance regulations and restrictions are expressed in the same units as as used in the regulation. The unit is explicitly included with the property in the data. + All quantities that relate to posted or ordinance regulations and restrictions are expressed in the same units as used in the regulation. The unit is explicitly included with the property in the data. ### Opening hours/validity Periods Opening Hours and the time frame during which time dependent properties are applicable are indicated following the [OSM Opening Hours specification] (https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification) diff --git a/docs/schema/concepts/by-theme/buildings/index.mdx b/docs/schema/concepts/by-theme/buildings/index.mdx index 94084cc73..2a2a87c47 100644 --- a/docs/schema/concepts/by-theme/buildings/index.mdx +++ b/docs/schema/concepts/by-theme/buildings/index.mdx @@ -25,7 +25,7 @@ The buildings theme has two feature types: ## Theme concepts -Both building and building_part types may have many **shape** related properties. These are useful for expressing the physical shape characteristics of the buidling including `roof_height`, `roof_shape`, `roof_material`, `facade_material`, etc. +Both building and building_part types may have many **shape** related properties. These are useful for expressing the physical shape characteristics of the building including `roof_height`, `roof_shape`, `roof_material`, `facade_material`, etc. ### Properties derived from OpenStreetMap tags @@ -114,7 +114,7 @@ There are a handful of common formatting issues that we generally allow when par ```sql ^\s*\d+(\.\d*)?\s*(m|meter|metre)s?\s*$ ``` - Height strings with a number follwed by a metric unit that matches the singular + Height strings with a number followed by a metric unit that matches the singular or plural version form of `m`, `meter`, and `metre` strings after the number are also treated as meters and the units are stripped. These values are not rounded. Examples: diff --git a/docs/schema/concepts/by-theme/transportation/roads.mdx b/docs/schema/concepts/by-theme/transportation/roads.mdx index 55a78e67f..5b4cb234e 100644 --- a/docs/schema/concepts/by-theme/transportation/roads.mdx +++ b/docs/schema/concepts/by-theme/transportation/roads.mdx @@ -27,7 +27,7 @@ import ExampleTurnRestriction2Connector1 from '!!raw-loader!@site/docs/_examples import ExampleTurnRestriction2Connector2 from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-02-connector2.yaml'; In the Overture transportation theme, a road is any kind of road, -street, or path, including a dedicated paths for walking or cycling. (Railways and waterways are separate subtypes in the transportation schema.) Road segments comprise the majority of ground-based transportation segments. Roads are modeled using [segment](/schema/reference/transportation/segment) features with the `subtype` property value set to the value `road`. +street, or path, including dedicated paths for walking or cycling. (Railways and waterways are separate subtypes in the transportation schema.) Road segments comprise the majority of ground-based transportation segments. Roads are modeled using [segment](/schema/reference/transportation/segment) features with the `subtype` property value set to the value `road`. This document describes properties specific to the `road` subtype. For more general information regarding segments, please refer to the [segments concept overview](/schema/concepts/by-theme/transportation/segments). diff --git a/docs/schema/concepts/by-theme/transportation/travel-modes.mdx b/docs/schema/concepts/by-theme/transportation/travel-modes.mdx index 88c825104..788d3c461 100644 --- a/docs/schema/concepts/by-theme/transportation/travel-modes.mdx +++ b/docs/schema/concepts/by-theme/transportation/travel-modes.mdx @@ -101,7 +101,7 @@ unique, but order is not important. #### Vehicle attribute scoping: `vehicle` -Because travel modes are an fuzzy concept, there are inevitably areas +Because travel modes are a fuzzy concept, there are inevitably areas of overlap between with the more precise, but more limited, `vehicle` scoping property which is used for [vehicle attributes scoping](/schema/concepts/scoping-rules#vehicle-attributes-scoping). Where there is potential overlap, the method of scoping used in Overture data releases will depend on how the upstream data source has expressed the equivalent concept. Where there is choice, it is preferable to select the scoping method that most accurately reflects the intention expressed on local signage. @@ -151,7 +151,7 @@ diagram below. As many of the above travel modes draw on the body of knowledge accumulated in relation to OpenStreetMap [transport mode access restrictions](https://wiki.openstreetmap.org/wiki/Key:access#Transport_mode_restrictions), -Overture Maps would like acknowledge a intellectual debt to the OSM community in +Overture Maps would like to acknowledge an intellectual debt to the OSM community in relation to travel modes as well as to other aspects of the transportation schema. ## Open questions diff --git a/docs/schema/concepts/scoping-rules.mdx b/docs/schema/concepts/scoping-rules.mdx index 3877f88db..87d862216 100644 --- a/docs/schema/concepts/scoping-rules.mdx +++ b/docs/schema/concepts/scoping-rules.mdx @@ -131,17 +131,16 @@ detail. A travel mode is a way of moving about the transportation network, for example driving in a motor vehicle, or, more specifically, driving in a high-occupancy vehicle. -The property construct `when: { mode: [...] }` limits the scope its parent value to apply only to people or things travelling using the listed travel modes. +The property construct `when: { mode: [...] }` limits the scope of its parent value to apply only to people or things travelling using the listed travel modes. To dive deeper into this topic, see the page on [travel modes](https://docs.overturemaps.org/guides/transportation/travel-modes). -#### Heading #### Heading -Heading scoping limits the the scope of a parent value to apply only when the traveller is proceeding along the segment geometry in the named direction, either `forward` or `backward`. +Heading scoping limits the scope of a parent value to apply only when the traveller is proceeding along the segment geometry in the named direction, either `forward` or `backward`. (*The directions `forward` and `backward` are defined on the [shape and connectivity](https://docs.overturemaps.org/guides/transportation/shape-connectivity) page.*) The property construct `when: { heading: forward|backward }` applies heading scoping to a parent value. diff --git a/docs/schema/reference/divisions/division.mdx b/docs/schema/reference/divisions/division.mdx index 3062fe56c..53b19736e 100644 --- a/docs/schema/reference/divisions/division.mdx +++ b/docs/schema/reference/divisions/division.mdx @@ -40,7 +40,7 @@ A division is a recognized official or non-official organization of people as se ## Subtypes -While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today. +While the schema for the divisions theme contains a comprehensive list of subtypes, only a subset are available in the data today. Currently, the following subtypes are available in the `division` feature type: diff --git a/docs/schema/reference/divisions/division_area.mdx b/docs/schema/reference/divisions/division_area.mdx index 677d7a4e8..9ea1b4e20 100644 --- a/docs/schema/reference/divisions/division_area.mdx +++ b/docs/schema/reference/divisions/division_area.mdx @@ -38,7 +38,7 @@ A division area is a polygon that represents the land or maritime area associate ## Subtypes -While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today. +While the schema for the divisions theme contains a comprehensive list of subtypes, only a subset are available in the data today. Currently, the following subtypes are available in the `division_area` feature type: @@ -63,7 +63,7 @@ Currently, the following subtypes are available in the `division_area` feature t -A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [divsion boundary](/schema/reference/divisions/division_boundary) features. Example: United States +A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [division boundary](/schema/reference/divisions/division_boundary) features. Example: United States diff --git a/docs/schema/reference/divisions/division_boundary.mdx b/docs/schema/reference/divisions/division_boundary.mdx index c28788d7e..54dc993ce 100644 --- a/docs/schema/reference/divisions/division_boundary.mdx +++ b/docs/schema/reference/divisions/division_boundary.mdx @@ -43,7 +43,7 @@ of a division. ## Subtypes -While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today. +While the schema for the divisions theme contains a comprehensive list of subtypes, only a subset are available in the data today. Currently, the following subtypes are available in the `division_boundary` feature type: @@ -63,7 +63,7 @@ Currently, the following subtypes are available in the `division_boundary` featu -A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [divsion boundary](/schema/reference/divisions/division_boundary) features. Example: United States +A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [division boundary](/schema/reference/divisions/division_boundary) features. Example: United States diff --git a/packages/overture-schema-addresses-theme/tests/address_baseline_schema.json b/packages/overture-schema-addresses-theme/tests/address_baseline_schema.json index 69fcb73c6..c678131da 100644 --- a/packages/overture-schema-addresses-theme/tests/address_baseline_schema.json +++ b/packages/overture-schema-addresses-theme/tests/address_baseline_schema.json @@ -156,7 +156,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-base-theme/src/overture/schema/base/infrastructure.py b/packages/overture-schema-base-theme/src/overture/schema/base/infrastructure.py index 9b820b92f..fee9d67c4 100644 --- a/packages/overture-schema-base-theme/src/overture/schema/base/infrastructure.py +++ b/packages/overture-schema-base-theme/src/overture/schema/base/infrastructure.py @@ -230,7 +230,7 @@ class Infrastructure( SourcedFromOpenStreetMap, ): """ - Infrastructure features provide basic information about real-world infrastructure entitites + Infrastructure features provide basic information about real-world infrastructure entities such as bridges, airports, runways, aerialways, communication towers, and power lines. """ diff --git a/packages/overture-schema-base-theme/src/overture/schema/base/land_use.py b/packages/overture-schema-base-theme/src/overture/schema/base/land_use.py index 2cc340c17..20a99c06a 100644 --- a/packages/overture-schema-base-theme/src/overture/schema/base/land_use.py +++ b/packages/overture-schema-base-theme/src/overture/schema/base/land_use.py @@ -185,7 +185,7 @@ class LandUse( activity, recreation, farming, housing, education, or military use. Land use features relate to `LandCover` features in the following way: land use is the human - human activity being done with the land, while land cover is the physical thing that covers it. + activity being done with the land, while land cover is the physical thing that covers it. TODO: Explain relationship to `Land` features. """ diff --git a/packages/overture-schema-base-theme/tests/bathymetry_baseline_schema.json b/packages/overture-schema-base-theme/tests/bathymetry_baseline_schema.json index 6e11a6057..0b0b1fb57 100644 --- a/packages/overture-schema-base-theme/tests/bathymetry_baseline_schema.json +++ b/packages/overture-schema-base-theme/tests/bathymetry_baseline_schema.json @@ -229,7 +229,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-base-theme/tests/infrastructure_baseline_schema.json b/packages/overture-schema-base-theme/tests/infrastructure_baseline_schema.json index 9b2d4f1d8..2789a1d21 100644 --- a/packages/overture-schema-base-theme/tests/infrastructure_baseline_schema.json +++ b/packages/overture-schema-base-theme/tests/infrastructure_baseline_schema.json @@ -457,7 +457,7 @@ } }, "additionalProperties": false, - "description": "Infrastructure features provide basic information about real-world infrastructure entitites\nsuch as bridges, airports, runways, aerialways, communication towers, and power lines.", + "description": "Infrastructure features provide basic information about real-world infrastructure entities\nsuch as bridges, airports, runways, aerialways, communication towers, and power lines.", "properties": { "bbox": { "description": "An optional bounding box for the feature", @@ -629,7 +629,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-base-theme/tests/land_baseline_schema.json b/packages/overture-schema-base-theme/tests/land_baseline_schema.json index a299e8574..6dac56f7b 100644 --- a/packages/overture-schema-base-theme/tests/land_baseline_schema.json +++ b/packages/overture-schema-base-theme/tests/land_baseline_schema.json @@ -502,7 +502,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-base-theme/tests/land_cover_baseline_schema.json b/packages/overture-schema-base-theme/tests/land_cover_baseline_schema.json index 98c372db0..68bc91e6d 100644 --- a/packages/overture-schema-base-theme/tests/land_cover_baseline_schema.json +++ b/packages/overture-schema-base-theme/tests/land_cover_baseline_schema.json @@ -246,7 +246,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-base-theme/tests/land_use_baseline_schema.json b/packages/overture-schema-base-theme/tests/land_use_baseline_schema.json index 97cd3c13d..2065c7732 100644 --- a/packages/overture-schema-base-theme/tests/land_use_baseline_schema.json +++ b/packages/overture-schema-base-theme/tests/land_use_baseline_schema.json @@ -408,7 +408,7 @@ } }, "additionalProperties": false, - "description": "Land use features specify the predominant human use of an area of land, for example commercial\nactivity, recreation, farming, housing, education, or military use.\n\nLand use features relate to `LandCover` features in the following way: land use is the human\nhuman activity being done with the land, while land cover is the physical thing that covers it.\n\nTODO: Explain relationship to `Land` features.", + "description": "Land use features specify the predominant human use of an area of land, for example commercial\nactivity, recreation, farming, housing, education, or military use.\n\nLand use features relate to `LandCover` features in the following way: land use is the human\nactivity being done with the land, while land cover is the physical thing that covers it.\n\nTODO: Explain relationship to `Land` features.", "properties": { "bbox": { "description": "An optional bounding box for the feature", @@ -580,7 +580,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-base-theme/tests/water_baseline_schema.json b/packages/overture-schema-base-theme/tests/water_baseline_schema.json index 94a796c01..d2edfe0be 100644 --- a/packages/overture-schema-base-theme/tests/water_baseline_schema.json +++ b/packages/overture-schema-base-theme/tests/water_baseline_schema.json @@ -463,7 +463,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-buildings-theme/tests/building_baseline_schema.json b/packages/overture-schema-buildings-theme/tests/building_baseline_schema.json index ab7542026..fd835b8b1 100644 --- a/packages/overture-schema-buildings-theme/tests/building_baseline_schema.json +++ b/packages/overture-schema-buildings-theme/tests/building_baseline_schema.json @@ -525,7 +525,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-buildings-theme/tests/building_part_baseline_schema.json b/packages/overture-schema-buildings-theme/tests/building_part_baseline_schema.json index 3c8d750a5..759e2a510 100644 --- a/packages/overture-schema-buildings-theme/tests/building_part_baseline_schema.json +++ b/packages/overture-schema-buildings-theme/tests/building_part_baseline_schema.json @@ -411,7 +411,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-common/src/overture/schema/common/models.py b/packages/overture-schema-common/src/overture/schema/common/models.py index dbb77a281..9a364f639 100644 --- a/packages/overture-schema-common/src/overture/schema/common/models.py +++ b/packages/overture-schema-common/src/overture/schema/common/models.py @@ -37,7 +37,7 @@ class OvertureFeature(Identified, Feature, Generic[ThemeT, TypeT]): """Base class for all Overture features.""" - # Only used to suport `ext_*` fields, which are on a deprecation path. + # Only used to support `ext_*` fields, which are on a deprecation path. model_config = ConfigDict(extra="allow") # Required @@ -89,7 +89,7 @@ def __get_pydantic_json_schema__( "description": textwrap.dedent(""" Additional top-level properties are allowed if prefixed by `ext_`. - This feature is a on a deprecation path and will be removed once the schema is + This feature is on a deprecation path and will be removed once the schema is fully migrated to Pydantic. """).strip(), } diff --git a/packages/overture-schema-common/src/overture/schema/common/scoping/__init__.py b/packages/overture-schema-common/src/overture/schema/common/scoping/__init__.py index 8f89d790f..b7e703b5d 100644 --- a/packages/overture-schema-common/src/overture/schema/common/scoping/__init__.py +++ b/packages/overture-schema-common/src/overture/schema/common/scoping/__init__.py @@ -13,7 +13,7 @@ Perhaps a tunnel is 10 meters deep for the first 100 meters, then rises a bit to only 7 meters deep for the next 100 meters. These depth observations would be modeled in the Overture schema using geometric range scoping (linear referencing): you would give your tunnel model an array of depth -obervations, and each observation would contain a linearly-referenced depth value. +observations, and each observation would contain a linearly-referenced depth value. >>> from typing import Annotated, Literal >>> from pydantic import BaseModel diff --git a/packages/overture-schema-common/src/overture/schema/common/scoping/scoped.py b/packages/overture-schema-common/src/overture/schema/common/scoping/scoped.py index 23fcc3404..068b423fe 100644 --- a/packages/overture-schema-common/src/overture/schema/common/scoping/scoped.py +++ b/packages/overture-schema-common/src/overture/schema/common/scoping/scoped.py @@ -65,7 +65,7 @@ class Scope(str, Enum): In order to add `when.heading`, this scope will place it into a containing `when` field in the model it decorates. The type of the `when` field will be a new model class named `When` that will be added as a nested class of the decorated model. Consequently, the decorated model must - not aready have a `when` field or a nested class named `When`. + not already have a `when` field or a nested class named `When`. """ TEMPORAL = "temporal" @@ -78,7 +78,7 @@ class Scope(str, Enum): In order to add `when.during`, this scope will place it into a containing `when` field in the model it decorates. The type of the `when` field will be a new model class named `When` that will be added as a nested class of the decorated model. Consequently, the decorated model must - not aready have a `when` field or a nested class named `When`. + not already have a `when` field or a nested class named `When`. """ TRAVEL_MODE = "travel_mode" @@ -104,7 +104,7 @@ class Scope(str, Enum): In order to add `when.using`, this scope will place it into a containing `when` field in the model it decorates. The type of the `when` field will be a new model class named `When` that will be added as a nested class of the decorated model. Consequently, the decorated model must - not aready have a `when` field or a nested class named `When`. + not already have a `when` field or a nested class named `When`. """ RECOGNIZED_STATUS = "recognized_status" @@ -118,7 +118,7 @@ class Scope(str, Enum): In order to add `when.recognized`, this scope will place it into a containing `when` field in the model it decorates. The type of the `when` field will be a new model class named `When` that will be added as a nested class of the decorated model. Consequently, the decorated model must - not aready have a `when` field or a nested class named `When`. + not already have a `when` field or a nested class named `When`. """ SIDE = "side" @@ -144,7 +144,7 @@ class Scope(str, Enum): In order to add `when.vehicle`, this scope will place it into a containing `when` field in the model it decorates. The type of the `when` field will be a new model class named `When` that will be added as a nested class of the decorated model. Consequently, the decorated model must - not aready have a `when` field or a nested class named `When`. + not already have a `when` field or a nested class named `When`. """ def _field(self, parent: str, required: bool) -> object: diff --git a/packages/overture-schema-common/src/overture/schema/common/scoping/travel_mode.py b/packages/overture-schema-common/src/overture/schema/common/scoping/travel_mode.py index 20c068506..932733d54 100644 --- a/packages/overture-schema-common/src/overture/schema/common/scoping/travel_mode.py +++ b/packages/overture-schema-common/src/overture/schema/common/scoping/travel_mode.py @@ -1,5 +1,5 @@ """ -Types supporting the trravel mode scope. +Types supporting the travel mode scope. """ from enum import Enum diff --git a/packages/overture-schema-divisions-theme/tests/division_area_baseline_schema.json b/packages/overture-schema-divisions-theme/tests/division_area_baseline_schema.json index 1eeeaedae..4e44c64d8 100644 --- a/packages/overture-schema-divisions-theme/tests/division_area_baseline_schema.json +++ b/packages/overture-schema-divisions-theme/tests/division_area_baseline_schema.json @@ -520,7 +520,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-divisions-theme/tests/division_baseline_schema.json b/packages/overture-schema-divisions-theme/tests/division_baseline_schema.json index a542515f4..487fec682 100644 --- a/packages/overture-schema-divisions-theme/tests/division_baseline_schema.json +++ b/packages/overture-schema-divisions-theme/tests/division_baseline_schema.json @@ -595,7 +595,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-divisions-theme/tests/division_boundary_baseline_schema.json b/packages/overture-schema-divisions-theme/tests/division_boundary_baseline_schema.json index 12f74343d..ba17bf758 100644 --- a/packages/overture-schema-divisions-theme/tests/division_boundary_baseline_schema.json +++ b/packages/overture-schema-divisions-theme/tests/division_boundary_baseline_schema.json @@ -448,7 +448,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-places-theme/tests/place_baseline_schema.json b/packages/overture-schema-places-theme/tests/place_baseline_schema.json index 8805de8e6..7009bb3c7 100644 --- a/packages/overture-schema-places-theme/tests/place_baseline_schema.json +++ b/packages/overture-schema-places-theme/tests/place_baseline_schema.json @@ -427,7 +427,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-system/src/overture/schema/system/__init__.py b/packages/overture-schema-system/src/overture/schema/system/__init__.py index 26ebf5085..a491d860f 100644 --- a/packages/overture-schema-system/src/overture/schema/system/__init__.py +++ b/packages/overture-schema-system/src/overture/schema/system/__init__.py @@ -22,7 +22,7 @@ help a Pydantic model's optional fields behave closer to JSON Schema semantics. - :mod:`primitive ` Primitive data types, including numeric and geometry types. -- :mod:`ref ` Unique IDs and annotations to descrie relationships +- :mod:`ref ` Unique IDs and annotations to describe relationships between models based on unique IDs. (*i.e.*, foreign key relationships). - :mod:`string ` String types with built-in validation to conform to well-known patterns, for example a country code, a hexadecimal color code, a language tag, or just diff --git a/packages/overture-schema-system/src/overture/schema/system/_json_schema.py b/packages/overture-schema-system/src/overture/schema/system/_json_schema.py index 64bc288ac..f65f5385d 100644 --- a/packages/overture-schema-system/src/overture/schema/system/_json_schema.py +++ b/packages/overture-schema-system/src/overture/schema/system/_json_schema.py @@ -264,7 +264,7 @@ def put_properties( If the target JSON Schema already contains a `"properties"` clause, the new properties from `new_properties` are merged into it. Otherwise, a new `"properties"` clause is inserted into - `json_schema` and and all properties from `new_properties` are inserted into it. + `json_schema` and all properties from `new_properties` are inserted into it. Parameters ---------- diff --git a/packages/overture-schema-transportation-theme/tests/connector_baseline_schema.json b/packages/overture-schema-transportation-theme/tests/connector_baseline_schema.json index dab0d3051..14cda8519 100644 --- a/packages/overture-schema-transportation-theme/tests/connector_baseline_schema.json +++ b/packages/overture-schema-transportation-theme/tests/connector_baseline_schema.json @@ -141,7 +141,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/packages/overture-schema-transportation-theme/tests/segment_baseline_schema.json b/packages/overture-schema-transportation-theme/tests/segment_baseline_schema.json index d121e69c4..03122b123 100644 --- a/packages/overture-schema-transportation-theme/tests/segment_baseline_schema.json +++ b/packages/overture-schema-transportation-theme/tests/segment_baseline_schema.json @@ -582,7 +582,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { @@ -852,7 +852,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { @@ -1614,7 +1614,7 @@ }, "patternProperties": { "^ext_.*$": { - "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is a on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." + "description": "Additional top-level properties are allowed if prefixed by `ext_`.\n\nThis feature is on a deprecation path and will be removed once the schema is\nfully migrated to Pydantic." } }, "properties": { diff --git a/reference/examples/addresses/address_all_missing_address_levels.yaml b/reference/examples/addresses/address_all_missing_address_levels.yaml index 8e29e9cef..386a59efd 100644 --- a/reference/examples/addresses/address_all_missing_address_levels.yaml +++ b/reference/examples/addresses/address_all_missing_address_levels.yaml @@ -1,5 +1,5 @@ --- -id: overture:addresses:addres:1 +id: overture:addresses:address:1 type: Feature geometry: type: Point diff --git a/schema/base/water.yaml b/schema/base/water.yaml index 0372e7161..437a925bb 100644 --- a/schema/base/water.yaml +++ b/schema/base/water.yaml @@ -25,7 +25,7 @@ properties: - class properties: subtype: - description: The type of water body such as an river, ocean or lake. + description: The type of water body such as a river, ocean or lake. default: [water] type: string enum: