Skip to content

Commit aa07fbb

Browse files
binaryseedbinaryseed
authored
Consistant docstring formatting (#32)
1 parent 3924874 commit aa07fbb

File tree

5 files changed

+37
-37
lines changed

5 files changed

+37
-37
lines changed

‎felt_python/layer_groups.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ def update_layer_groups(
6464
6565
Args:
6666
map_id: The ID of the map containing the layer groups
67-
layer_group_params_list: List of layer group parameters to update
68-
Each dict must contain at least "name" key
69-
Optional keys include "id", "caption", "ordering_key"
67+
layer_group_params_list: List of layer group parameters to update.
68+
Each dict must contain at least "name" key.
69+
Optional keys include "id", "caption", "ordering_key".
7070
api_token: Optional API token
7171
7272
Returns:

‎felt_python/layers.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -296,10 +296,10 @@ def update_layers(
296296
297297
Args:
298298
map_id: The ID of the map containing the layers
299-
layer_params_list: List of layer parameters to update
300-
Each dict must contain at least an "id" key
301-
Optional keys include "name", "caption",
302-
"metadata", "ordering_key", "refresh_period"
299+
layer_params_list: List of layer parameters to update.
300+
Each dict must contain at least an "id" key.
301+
Optional keys include "name", "caption",
302+
"metadata", "ordering_key", "refresh_period".
303303
api_token: Optional API token
304304
305305
Returns:
@@ -371,10 +371,10 @@ def create_custom_export(
371371
map_id: The ID of the map containing the layer
372372
layer_id: The ID of the layer to export
373373
output_format: The format to export in.
374-
Options are "csv", "gpkg", or "geojson"
374+
Options are "csv", "gpkg", or "geojson"
375375
filters: Optional list of filters in Felt Style Language filter format
376376
email_on_completion: Whether to send an email when the export completes.
377-
Defaults to True.
377+
Defaults to True.
378378
api_token: Optional API token
379379
380380
Returns:
@@ -433,12 +433,12 @@ def duplicate_layers(
433433
434434
Args:
435435
duplicate_params: List of layer duplication parameters. Each dict must contain:
436-
- For duplicating a single layer:
437-
- "source_layer_id": ID of the layer to duplicate
438-
- "destination_map_id": ID of the map to duplicate to
439-
- For duplicating a layer group:
440-
- "source_layer_group_id": ID of the layer group to duplicate
441-
- "destination_map_id": ID of the map to duplicate to
436+
- For duplicating a single layer:
437+
- "source_layer_id": ID of the layer to duplicate
438+
- "destination_map_id": ID of the map to duplicate to
439+
- For duplicating a layer group:
440+
- "source_layer_group_id": ID of the layer group to duplicate
441+
- "destination_map_id": ID of the map to duplicate to
442442
api_token: Optional API token
443443
444444
Returns:

‎felt_python/library.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ def list_library_layers(source: str = "workspace", api_token: str | None = None)
1515
1616
Args:
1717
source: The source of library layers to list.
18-
Options are:
19-
- "workspace": list layers from your workspace library (default)
20-
- "felt": list layers from the Felt data library
21-
- "all": list layers from both sources
18+
Options are:
19+
- "workspace": list layers from your workspace library (default)
20+
- "felt": list layers from the Felt data library
21+
- "all": list layers from both sources
2222
api_token: Optional API token
2323
2424
Returns:

‎felt_python/maps.py‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,22 @@ def create_map(
3535
title: The title to be used for the map. Defaults to "Untitled Map"
3636
description: A description to display in the map legend
3737
public_access: The level of access to grant to the map.
38-
Options are "private", "view_only", "view_and_comment",
39-
or "view_comment_and_edit". Defaults to "view_only".
38+
Options are "private", "view_only", "view_and_comment",
39+
or "view_comment_and_edit". Defaults to "view_only".
4040
basemap: The basemap to use for the new map. Defaults to "default".
41-
Valid values are "default", "light", "dark", "satellite",
42-
a valid raster tile URL with {x}, {y}, and {z} parameters,
43-
or a hex color string like #ff0000.
41+
Valid values are "default", "light", "dark", "satellite",
42+
a valid raster tile URL with {x}, {y}, and {z} parameters,
43+
or a hex color string like #ff0000.
4444
lat: If no data has been uploaded to the map, the initial latitude
4545
to center the map display on.
4646
lon: If no data has been uploaded to the map, the initial longitude
4747
to center the map display on.
4848
zoom: If no data has been uploaded to the map, the initial zoom level
49-
for the map to display.
49+
for the map to display.
5050
layer_urls: An array of urls to use to create layers in the map.
51-
Only tile URLs for raster layers are supported at the moment.
51+
Only tile URLs for raster layers are supported at the moment.
5252
workspace_id: The workspace to create the map in.
53-
Defaults to the latest used workspace.
53+
Defaults to the latest used workspace.
5454
api_token: Optional API token
5555
5656
Returns:
@@ -215,8 +215,8 @@ def create_embed_token(
215215
Args:
216216
map_id: The ID of the map to create an embed token for
217217
user_email: Optionally assign the token to a user email address.
218-
Providing an email will enable the viewer to export data
219-
if the Map allows it.
218+
Providing an email will enable the viewer to export data
219+
if the Map allows it.
220220
api_token: Optional API token
221221
222222
Returns:
@@ -241,11 +241,11 @@ def add_source_layer(
241241
242242
Args:
243243
map_id: The ID of the map to add the layer to
244-
source_layer_params: Parameters defining the source layer to add
245-
Must include "from" key with one of these values:
246-
- "dataset": requires "dataset_id"
247-
- "sql": requires "source_id" and "query"
248-
- "stac": requires "source_id" and "stac_asset_url"
244+
source_layer_params: Parameters defining the source layer to add.
245+
Must include "from" key with one of these values:
246+
- "dataset": requires "dataset_id"
247+
- "sql": requires "source_id" and "query"
248+
- "stac": requires "source_id" and "stac_asset_url"
249249
api_token: Optional API token
250250
251251
Returns:
@@ -273,9 +273,9 @@ def duplicate_map(
273273
map_id: The ID of the map to duplicate
274274
title: Optional title for the duplicated map
275275
project_id: The ID of the project to place the duplicated map in
276-
(mutually exclusive with folder_id)
276+
(mutually exclusive with folder_id)
277277
folder_id: The ID of the folder to place the duplicated map in
278-
(mutually exclusive with project_id)
278+
(mutually exclusive with project_id)
279279
api_token: Optional API token
280280
281281
Returns:

‎felt_python/projects.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def create_project(name: str, visibility: str, api_token: str | None = None):
3131
Args:
3232
name: The name to be used for the Project
3333
visibility: Either "workspace" (viewable by all members of the workspace)
34-
or "private" (private to users who are invited)
34+
or "private" (private to users who are invited)
3535
api_token: Optional API token
3636
3737
Returns:

0 commit comments

Comments
 (0)