From ab63bfeb28e81dde411f928426c49bd78be971a9 Mon Sep 17 00:00:00 2001 From: "Keto D. Zhang" Date: Fri, 14 Jun 2024 11:17:11 -0700 Subject: [PATCH] docs: "ASDF Model" should be stylized as "ASDF Pydantic model" --- docs/model.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/model.md b/docs/model.md index 9d628ed..3d550f5 100644 --- a/docs/model.md +++ b/docs/model.md @@ -1,6 +1,6 @@ ```{currentmodule} asdf_pydantic ``` -# Writing ASDF Models to define tagged objects +# Writing ASDF Pydantic models to define tagged objects The {py:class}`AsdfPydanticModel` is a class that combines the feature of [`pydantic.BaseModel`](https://docs.pydantic.dev/usage/models/) and ASDF @@ -17,7 +17,7 @@ class Rectangle(AsdfPydanticModel): This `Rectangle` model will be referenced in ASDF's YAML file as `!rectangle-1.0.0` specified by the `_tag` field. `_tag` is a globally unique ASDF tag (see [naming best practices](https://asdf.readthedocs.io/en/stable/asdf/extending/uris.html#tags)) -that identifies the ASDF model. This model contains two fields: `width` and +that identifies the ASDF Pydantic model. This model contains two fields: `width` and `height` and their field type are both `float`. ## Field Types