Skip to content

Commit 7970325

Browse files
committed
use dash instead of underscore in all cases
1 parent 85ab900 commit 7970325

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

docs/cli/cli-orders.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ planet orders request \
236236
--name 'My First Order' \
237237
20220605_124027_64_242b \
238238
--hosting sentinel_hub \
239-
--collection_id ba8f7274-aacc-425e-8a38-e21517bfbeff
239+
--collection-id ba8f7274-aacc-425e-8a38-e21517bfbeff
240240
```
241241

242242
```
@@ -246,12 +246,12 @@ planet orders request \
246246
--name 'My First Order' \
247247
20220605_124027_64_242b \
248248
--hosting sentinel_hub \
249-
--create_configuration
249+
--create-configuration
250250
```
251251

252252
- The --hosting option is optional and currently supports sentinel_hub as its only value.
253-
- The --collection_id is also optional. If you decide to use this, ensure that the order request and the collection have matching bands. If you're unsure, allow the system to create a new collection for you by omitting the --collection_id option. This will ensure the newly set-up collection is configured correctly, and you can subsequently add items to this collection as needed.
254-
- The --create_configuration option will create a new [layer configuration](https://apps.sentinel-hub.com/dashboard/#/configurations) in Sentinel Hub on your behalf. This option cannot be used with --collection_id.
253+
- The --collection-id is also optional. If you decide to use this, ensure that the order request and the collection have matching bands. If you're unsure, allow the system to create a new collection for you by omitting the --collection-id option. This will ensure the newly set-up collection is configured correctly, and you can subsequently add items to this collection as needed.
254+
- The --create-configuration option will create a new [layer configuration](https://apps.sentinel-hub.com/dashboard/#/configurations) in Sentinel Hub on your behalf. This option cannot be used with --collection-id.
255255

256256
For more information on Sentinel Hub hosting, see the [Orders API documentation](https://developers.planet.com/apis/orders/delivery/#delivery-to-sentinel-hub-collection) and the [Linking Planet User to Sentinel Hub User
257257
](https://support.planet.com/hc/en-us/articles/16550358397469-Linking-Planet-User-to-Sentinel-Hub-User) support post.
@@ -318,18 +318,18 @@ if you run that command again it will create a second order).
318318

319319
#### Sentinel Hub Hosting
320320

321-
For convenience, `planet orders create` accepts the same `--hosting`, `--collection_id`, and `--create_configuration` options that [`planet orders request`](#sentinel-hub-hosting) does.
321+
For convenience, `planet orders create` accepts the same `--hosting`, `--collection-id`, and `--create-configuration` options that [`planet orders request`](#sentinel-hub-hosting) does.
322322

323323
```sh
324324
planet orders create request-1.json \
325325
--hosting sentinel_hub \
326-
--collection_id ba8f7274-aacc-425e-8a38-e21517bfbeff
326+
--collection-id ba8f7274-aacc-425e-8a38-e21517bfbeff
327327
```
328328

329329
```sh
330330
planet orders create request-1.json \
331331
--hosting sentinel_hub \
332-
--create_configuration
332+
--create-configuration
333333
```
334334

335335
### Create Request and Order in One Call

docs/cli/cli-subscriptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -541,8 +541,8 @@ planet subscriptions request \
541541
When creating a new subscription, you can include hosting options directly using the --hosting, --collection-id, and --create-configuration flags.
542542

543543
- The --hosting option is optional and currently supports sentinel_hub as its only value.
544-
- The --collection_id is also optional. If you decide to use this, ensure that the subscription request and the collection have matching bands. If you're unsure, allow the system to create a new collection for you by omitting the --collection_id option. This will ensure the newly set-up collection is configured correctly, and you can subsequently add items to this collection as needed.
545-
- The --create_configuration option will create a new [layer configuration](https://apps.sentinel-hub.com/dashboard/#/configurations) in Sentinel Hub on your behalf. This option cannot be used with --collection_id.
544+
- The --collection-id is also optional. If you decide to use this, ensure that the subscription request and the collection have matching bands. If you're unsure, allow the system to create a new collection for you by omitting the --collection-id option. This will ensure the newly set-up collection is configured correctly, and you can subsequently add items to this collection as needed.
545+
- The --create_configuration option will create a new [layer configuration](https://apps.sentinel-hub.com/dashboard/#/configurations) in Sentinel Hub on your behalf. This option cannot be used with --collection-id.
546546
- You may also input --hosting as a JSON file. The file should be formatted:
547547

548548
```sh

planet/cli/orders.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ async def create(ctx, request, pretty, **kwargs):
370370
type=click.Choice(['sentinel_hub']),
371371
help='Hosting for data delivery. '
372372
'Currently, only "sentinel_hub" is supported.')
373-
@click.option('--collection_id',
373+
@click.option('--collection-id',
374374
help='Collection ID for Sentinel Hub hosting. '
375375
'If omitted, a new collection will be created.')
376376
@click.option(

tests/integration/test_orders_cli.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -826,7 +826,7 @@ def test_cli_orders_request_hosting_sentinel_hub_collection_id(
826826
'--name=test',
827827
'20220325_131639_20_2402',
828828
'--hosting=sentinel_hub',
829-
'--collection_id=1234'
829+
'--collection-id=1234'
830830
])
831831

832832
order_request = {
@@ -859,7 +859,7 @@ def test_cli_orders_request_hosting_sentinel_hub_create_configuration(
859859
'--name=test',
860860
'20220325_131639_20_2402',
861861
'--hosting=sentinel_hub',
862-
'--create_configuration'
862+
'--create-configuration'
863863
])
864864

865865
order_request = {
@@ -892,8 +892,8 @@ def test_cli_orders_request_hosting_sentinel_hub_collection_configuration(
892892
'--name=test',
893893
'20220325_131639_20_2402',
894894
'--hosting=sentinel_hub',
895-
'--collection_id=1234',
896-
'--create_configuration'
895+
'--collection-id=1234',
896+
'--create-configuration'
897897
])
898898

899899
order_request = {

tests/integration/test_subscriptions_cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -467,10 +467,10 @@ def test_catalog_source_time_range_type(invoke, geom_geojson, time_range_type):
467467
"--collection-id=7ff105c4-e0de-4910-96db-8345d86ab734",
468468
None,
469469
True),
470-
("--hosting=sentinel_hub", None, "--create_configuration", True),
470+
("--hosting=sentinel_hub", None, "--create-configuration", True),
471471
("--hosting=sentinel_hub",
472472
"--collection-id=7ff105c4-e0de-4910-96db-8345d86ab734",
473-
"--create_configuration",
473+
"--create-configuration",
474474
True),
475475
])
476476
def test_request_hosting(invoke,

0 commit comments

Comments
 (0)