Skip to content

Commit 833bbbb

Browse files
committed
update guide
1 parent 70d81c1 commit 833bbbb

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/python/sdk-guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,8 @@ You will need your ACCESS_KEY_ID, SECRET_ACCESS_KEY, bucket and region name.
231231
To subscribe to scenes that match a filter, use the `subscription_request` module to build a request, and
232232
pass it to the `subscriptions.create_subscription()` method of the client.
233233

234+
By default, a request to create a subscription will not clip to the subscription source geometry. To clip to subscription source geometry, set `planet.subscription_request.build_request()` keyword argument `clip_to_source = True` as in the example below. To clip to a custom geometry, set `planet.subscription_request.build_request()` keyword argument `clip_to_source = False` (or omit it entirely to fall back on the default value), and instead configure the custom clip AOI with `planet.subscription_request.clip_tool()`.
235+
234236
Warning: the following code will create a subscription, consuming quota based on your plan.
235237

236238
```python
@@ -256,7 +258,7 @@ source = catalog_source(
256258
time_range_type="acquired",
257259
)
258260

259-
request = build_request("Standard PSScene Ortho Analytic", source=source, delivery={})
261+
request = build_request("Standard PSScene Ortho Analytic", source=source, delivery={}, clip_to_source=True)
260262

261263
# define a delivery method. In this example, we're using AWS S3.
262264
delivery = amazon_s3(ACCESS_KEY_ID, SECRET_ACCESS_KEY, "test", "us-east-1")

0 commit comments

Comments
 (0)