Skip to content

Commit 35ca9ef

Browse files
authored
Merge pull request #1158 from planetlabs/main
add Planet sync client to docs, fix docstring (#1153)
2 parents 94de3d4 + a582e1e commit 35ca9ef

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

docs/python/sdk-reference.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,6 @@ title: Python SDK API Reference
3838
rendering:
3939
show_root_full_path: false
4040

41-
41+
## ::: planet.Planet
42+
rendering:
43+
show_root_full_path: false

planet/sync/client.py

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ class Planet:
1616
Authentication is required: defaults to detecting API key from environment (PL_API_KEY).
1717
1818
Members:
19-
`data`: for interacting with the Planet Data API.
20-
`orders`: Orders API.
21-
`subscriptions`: Subscriptions API.
22-
`features`: Features API
19+
20+
- `data`: for interacting with the Planet Data API.
21+
- `orders`: Orders API.
22+
- `subscriptions`: Subscriptions API.
23+
- `features`: Features API
2324
2425
Quick start example:
2526
```python
@@ -35,13 +36,8 @@ class Planet:
3536
3637
Parameters:
3738
session: Optional Session. The Session can be provided allowing for customization, and
38-
will default to standard behavior when not provided. Example:
39-
40-
```python
41-
from planet.sync import Planet
39+
will default to standard behavior when not provided.
4240
43-
pl = Planet()
44-
````
4541
"""
4642

4743
def __init__(self, session: Optional[Session] = None) -> None:

0 commit comments

Comments
 (0)