From 1f2d7b3e2603d0857df44513871d4cdc3b8035fd Mon Sep 17 00:00:00 2001 From: Ian Schneider Date: Wed, 4 Jun 2025 10:55:43 -0600 Subject: [PATCH] add Planet sync client to docs, fix docstring --- docs/python/sdk-reference.md | 4 +++- planet/sync/client.py | 16 ++++++---------- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/python/sdk-reference.md b/docs/python/sdk-reference.md index dab105c11..dee669b39 100644 --- a/docs/python/sdk-reference.md +++ b/docs/python/sdk-reference.md @@ -38,4 +38,6 @@ title: Python SDK API Reference rendering: show_root_full_path: false - +## ::: planet.Planet + rendering: + show_root_full_path: false diff --git a/planet/sync/client.py b/planet/sync/client.py index 72420bf7c..691b67e66 100644 --- a/planet/sync/client.py +++ b/planet/sync/client.py @@ -16,10 +16,11 @@ class Planet: Authentication is required: defaults to detecting API key from environment (PL_API_KEY). Members: - `data`: for interacting with the Planet Data API. - `orders`: Orders API. - `subscriptions`: Subscriptions API. - `features`: Features API + + - `data`: for interacting with the Planet Data API. + - `orders`: Orders API. + - `subscriptions`: Subscriptions API. + - `features`: Features API Quick start example: ```python @@ -35,13 +36,8 @@ class Planet: Parameters: session: Optional Session. The Session can be provided allowing for customization, and - will default to standard behavior when not provided. Example: - - ```python - from planet.sync import Planet + will default to standard behavior when not provided. - pl = Planet() - ```` """ def __init__(self, session: Optional[Session] = None) -> None: