Skip to content

Commit 72cb188

Browse files
committed
Adjust Island client documentation to mention that a datetime.date may sometimes be returned
1 parent c6b3494 commit 72cb188

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

mcc_api/island/__init__.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,10 @@
5757
:external:py:meth:`client.execute() <gql.client.Client.execute>`. Queries are verified to be valid using according to
5858
the schema before being sent to the API, raising a
5959
:external:py:class:`graphql.GraphQLError <graphql.error.graphql_error.GraphQLError>` if not. The returned data will be a
60-
Python dictionary whose structure matches that of the query. Data returned as a UUID or a DateTime will be resolved as a
61-
:external:py:class:`UUID <.uuid.UUID>` or a :external:py:class:`datetime <.datetime.datetime>` object
62-
respectively. Some data may not be present if the user being queried has kept some of their data private to the API.
60+
Python dictionary whose structure matches that of the query. Data returned as a UUID, a Date, or a DateTime will be
61+
resolved as a :external:py:class:`UUID <.uuid.UUID>`, a :external:py:class:`date <.datetime.date>, or a
62+
:external:py:class:`datetime <.datetime.datetime>` object respectively. Some data may not be present if the user being
63+
queried has kept some of their data private to the API.
6364
6465
.. note::
6566
All API settings (collections, social, statistics, and status) are opt-in, and so all related data will be

0 commit comments

Comments
 (0)