Skip to content
This repository was archived by the owner on Jun 2, 2026. It is now read-only.

Update usage.md #121

Open
jacklj9811 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update usage.md #121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ search: List[Product] = ProductSearch(
versions=[ProductVersion.lf_2020],
themes=[ProductTheme.vegetation]
)
search = search.get_products()
search_products = search.get_products()
# ...returns 3 Products
```

The result of the example is a list of `Products`. Each `Product` is a [pydantic][pydantic] model and thus its fields can be accessed with dot notation:

```python
for product in search: print(product.name)
for product in search_products: print(product.name)
# existing vegetation cover 2022
# existing vegetation height 2022
# existing vegetation type 2020
Expand All @@ -62,7 +62,7 @@ Each `Product` also has a list of `Availability` models that provides informatio

```python
# Grab the first product (existing vegetation cover 2022), and first availability object (LANDFIRE 2020):
search[0].availability[0]
search_products[0].availability[0]
# ...returns
# ProductAvailability(version=<ProductVersion.lf_2020: '2.2.0'>,
# regions=[<ProductRegion.US: 'US'>,
Expand Down