From 2fb2d36e88e0bf81786988bef8fded89dd5bc0ed Mon Sep 17 00:00:00 2001 From: Vince Foley Date: Fri, 16 Jan 2026 13:19:12 -0800 Subject: [PATCH] Consistant docstring formatting --- felt_python/layer_groups.py | 6 +++--- felt_python/layers.py | 24 ++++++++++++------------ felt_python/library.py | 8 ++++---- felt_python/maps.py | 34 +++++++++++++++++----------------- felt_python/projects.py | 2 +- 5 files changed, 37 insertions(+), 37 deletions(-) diff --git a/felt_python/layer_groups.py b/felt_python/layer_groups.py index 5ada895..4dfdbfc 100644 --- a/felt_python/layer_groups.py +++ b/felt_python/layer_groups.py @@ -64,9 +64,9 @@ def update_layer_groups( Args: map_id: The ID of the map containing the layer groups - layer_group_params_list: List of layer group parameters to update - Each dict must contain at least "name" key - Optional keys include "id", "caption", "ordering_key" + layer_group_params_list: List of layer group parameters to update. + Each dict must contain at least "name" key. + Optional keys include "id", "caption", "ordering_key". api_token: Optional API token Returns: diff --git a/felt_python/layers.py b/felt_python/layers.py index 228d7fc..35f6d02 100644 --- a/felt_python/layers.py +++ b/felt_python/layers.py @@ -296,10 +296,10 @@ def update_layers( Args: map_id: The ID of the map containing the layers - layer_params_list: List of layer parameters to update - Each dict must contain at least an "id" key - Optional keys include "name", "caption", - "metadata", "ordering_key", "refresh_period" + layer_params_list: List of layer parameters to update. + Each dict must contain at least an "id" key. + Optional keys include "name", "caption", + "metadata", "ordering_key", "refresh_period". api_token: Optional API token Returns: @@ -371,10 +371,10 @@ def create_custom_export( map_id: The ID of the map containing the layer layer_id: The ID of the layer to export output_format: The format to export in. - Options are "csv", "gpkg", or "geojson" + Options are "csv", "gpkg", or "geojson" filters: Optional list of filters in Felt Style Language filter format email_on_completion: Whether to send an email when the export completes. - Defaults to True. + Defaults to True. api_token: Optional API token Returns: @@ -433,12 +433,12 @@ def duplicate_layers( Args: duplicate_params: List of layer duplication parameters. Each dict must contain: - - For duplicating a single layer: - - "source_layer_id": ID of the layer to duplicate - - "destination_map_id": ID of the map to duplicate to - - For duplicating a layer group: - - "source_layer_group_id": ID of the layer group to duplicate - - "destination_map_id": ID of the map to duplicate to + - For duplicating a single layer: + - "source_layer_id": ID of the layer to duplicate + - "destination_map_id": ID of the map to duplicate to + - For duplicating a layer group: + - "source_layer_group_id": ID of the layer group to duplicate + - "destination_map_id": ID of the map to duplicate to api_token: Optional API token Returns: diff --git a/felt_python/library.py b/felt_python/library.py index b359f4b..26aa0b9 100644 --- a/felt_python/library.py +++ b/felt_python/library.py @@ -15,10 +15,10 @@ def list_library_layers(source: str = "workspace", api_token: str | None = None) Args: source: The source of library layers to list. - Options are: - - "workspace": list layers from your workspace library (default) - - "felt": list layers from the Felt data library - - "all": list layers from both sources + Options are: + - "workspace": list layers from your workspace library (default) + - "felt": list layers from the Felt data library + - "all": list layers from both sources api_token: Optional API token Returns: diff --git a/felt_python/maps.py b/felt_python/maps.py index c532521..a967e93 100644 --- a/felt_python/maps.py +++ b/felt_python/maps.py @@ -35,22 +35,22 @@ def create_map( title: The title to be used for the map. Defaults to "Untitled Map" description: A description to display in the map legend public_access: The level of access to grant to the map. - Options are "private", "view_only", "view_and_comment", - or "view_comment_and_edit". Defaults to "view_only". + Options are "private", "view_only", "view_and_comment", + or "view_comment_and_edit". Defaults to "view_only". basemap: The basemap to use for the new map. Defaults to "default". - Valid values are "default", "light", "dark", "satellite", - a valid raster tile URL with {x}, {y}, and {z} parameters, - or a hex color string like #ff0000. + Valid values are "default", "light", "dark", "satellite", + a valid raster tile URL with {x}, {y}, and {z} parameters, + or a hex color string like #ff0000. lat: If no data has been uploaded to the map, the initial latitude to center the map display on. lon: If no data has been uploaded to the map, the initial longitude to center the map display on. zoom: If no data has been uploaded to the map, the initial zoom level - for the map to display. + for the map to display. layer_urls: An array of urls to use to create layers in the map. - Only tile URLs for raster layers are supported at the moment. + Only tile URLs for raster layers are supported at the moment. workspace_id: The workspace to create the map in. - Defaults to the latest used workspace. + Defaults to the latest used workspace. api_token: Optional API token Returns: @@ -193,8 +193,8 @@ def create_embed_token( Args: map_id: The ID of the map to create an embed token for user_email: Optionally assign the token to a user email address. - Providing an email will enable the viewer to export data - if the Map allows it. + Providing an email will enable the viewer to export data + if the Map allows it. api_token: Optional API token Returns: @@ -219,11 +219,11 @@ def add_source_layer( Args: map_id: The ID of the map to add the layer to - source_layer_params: Parameters defining the source layer to add - Must include "from" key with one of these values: - - "dataset": requires "dataset_id" - - "sql": requires "source_id" and "query" - - "stac": requires "source_id" and "stac_asset_url" + source_layer_params: Parameters defining the source layer to add. + Must include "from" key with one of these values: + - "dataset": requires "dataset_id" + - "sql": requires "source_id" and "query" + - "stac": requires "source_id" and "stac_asset_url" api_token: Optional API token Returns: @@ -251,9 +251,9 @@ def duplicate_map( map_id: The ID of the map to duplicate title: Optional title for the duplicated map project_id: The ID of the project to place the duplicated map in - (mutually exclusive with folder_id) + (mutually exclusive with folder_id) folder_id: The ID of the folder to place the duplicated map in - (mutually exclusive with project_id) + (mutually exclusive with project_id) api_token: Optional API token Returns: diff --git a/felt_python/projects.py b/felt_python/projects.py index a5048be..6285197 100644 --- a/felt_python/projects.py +++ b/felt_python/projects.py @@ -31,7 +31,7 @@ def create_project(name: str, visibility: str, api_token: str | None = None): Args: name: The name to be used for the Project visibility: Either "workspace" (viewable by all members of the workspace) - or "private" (private to users who are invited) + or "private" (private to users who are invited) api_token: Optional API token Returns: