Skip to content

add Planet sync client to docs, fix docstring #1153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

add Planet sync client to docs, fix docstring #1153

Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion docs/python/sdk-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,6 @@ title: Python SDK API Reference
rendering:
show_root_full_path: false


## ::: planet.Planet
rendering:
show_root_full_path: false
16 changes: 6 additions & 10 deletions planet/sync/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: is this newline a typo?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so. IIRC, it impacts rendering in unexpected ways.

- `data`: for interacting with the Planet Data API.
- `orders`: Orders API.
- `subscriptions`: Subscriptions API.
- `features`: Features API

Quick start example:
```python
Expand All @@ -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:
Expand Down