diff --git a/CHANGELOG.md b/CHANGELOG.md index 91e4cf1..aab1386 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,12 @@ +# v2.3.0 + +* Forbid extra attributes to all models + +# v2.2.3 + +* Correct inheritance of `PositionList`, `BoxDimensions()`, and `Rectangle()` +* Remove `HasAlignment()` + # v2.2.2 * Update license diff --git a/README.md b/README.md index cd468b3..286be7f 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ From the official [CZML Guide](https://github.com/AnalyticalGraphicsInc/czml-wri czml3 aims to make the process of writing CZML files in Python easy by: - Type checking properties - Cooercion of data to their required format +- Forbidding unrecognised properties - Creating minimal CZML files ## Insallation diff --git a/docs/index.rst b/docs/index.rst index 7136521..d0a43c9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,6 +14,7 @@ czml3 aims to make the process of writing CZML files in Python easy by: * Type checking properties * Cooercion of data to their required format +* Forbidding unrecognised properties * Creating minimal CZML files .. toctree:: diff --git a/docs/user/features.rst b/docs/user/features.rst index fb69210..565c114 100644 --- a/docs/user/features.rst +++ b/docs/user/features.rst @@ -6,12 +6,17 @@ The goal of czml3 is to make the process of writing CZML files in Python easy. T Type Checking ------------- -czml3 is built using Pydantic. Therefore, all classes enforces type checking on the inputs. This ensures that the data is in the correct format before it is written to the CZML file. +All classes enforces type checking on the inputs. This ensures that the data is in the correct format before it is written to the CZML file. Cooercion of Data ----------------- -Again, czml3 is build using Pydantic. Therefore, czml3 is able to `coerce data to their right type `_. See Example 2 in :ref:`examples-label`. +czml3 `coerces data to their right type `_. See Example 2 in :ref:`examples-label`. + +Forbid Unrecognised Properties +------------------------------ + +czml3 raises an error if a model (class) receives an unrecognised input. Minimal CZML File Creation --------------------------