Skip to content

Commit fbe577b

Browse files
author
gerdie
committed
update command descriptions
1 parent 3e77a8d commit fbe577b

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Unreleased
2+
- Provide description for `upload-source` command, and label `add-source` command as deprecated.
23

34
=======
45

mapbox_tilesets/scripts/cli.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -524,6 +524,11 @@ def validate_source(features):
524524
def upload_source(
525525
ctx, username, id, features, no_validation, quiet, replace, token=None, indent=None
526526
):
527+
"""Create a new tileset source, or add data to an existing tileset source.
528+
Optionally, replace an existing tileset source.
529+
530+
tilesets upload-source <username> <source_id> <path/to/source/data>
531+
"""
527532
return _upload_source(
528533
ctx, username, id, features, no_validation, quiet, replace, token, indent
529534
)
@@ -532,10 +537,6 @@ def upload_source(
532537
def _upload_source(
533538
ctx, username, id, features, no_validation, quiet, replace, token=None, indent=None
534539
):
535-
"""Create/add a tileset source
536-
537-
tilesets add-source <username> <source_id> <path/to/source/data>
538-
"""
539540
mapbox_api = utils._get_api()
540541
mapbox_token = utils._get_token(token)
541542
s = utils._get_session()
@@ -627,7 +628,7 @@ def callback(m):
627628
def add_source(
628629
ctx, username, id, features, no_validation, quiet, token=None, indent=None
629630
):
630-
"""Create/add/replace a tileset source
631+
"""[DEPRECATED] Create/add/replace a tileset source. Use upload-source instead.
631632
632633
tilesets add-source <username> <source_id> <path/to/source/data>
633634
"""

0 commit comments

Comments
 (0)