Skip to content

Commit 78010ac

Browse files
authored
Update client.py (#232)
Fix misleading language on the client docstring: DCIDs don't need a type.
1 parent 0cbfd8c commit 78010ac

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

datacommons_client/client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@ def observations_dataframe(
131131
variable_dcids (str | list[str]): One or more variable DCIDs for the observation.
132132
date (ObservationDate | str): The date for which observations are requested. It can be
133133
a specific date, "all" to retrieve all observations, or "latest" to get the most recent observations.
134-
entity_dcids (Literal["all"] | list[str], optional): The entity DCIDs to retrieve data for.
135-
Defaults to "all". DCIDs must include their type (e.g., "country/GTM" for Guatemala).
134+
entity_dcids (Literal["all"] | list[str], optional): The entity DCIDs for which to retrieve data.
135+
Defaults to "all".
136136
entity_type (Optional[str]): The type of entities to filter by when `entity_dcids="all"`.
137137
Required if `entity_dcids="all"`. Defaults to None.
138138
parent_entity (Optional[str]): The parent entity under which the target entities fall.

0 commit comments

Comments
 (0)