Skip to content

Commit

Permalink
docs: "ASDF Model" should be stylized as "ASDF Pydantic model"
Browse files Browse the repository at this point in the history
  • Loading branch information
ketozhang authored Jun 14, 2024
1 parent b943c1a commit ab63bfe
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/model.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down

0 comments on commit ab63bfe

Please sign in to comment.